From 86bc8855d54651f0102a2ba4735ccd6332987fd9 Mon Sep 17 00:00:00 2001 From: AllanZhengYP Date: Mon, 21 Mar 2022 19:12:43 +0000 Subject: [PATCH 1/2] chore(models): update models as of 03/21/2022 --- codegen/sdk-codegen/aws-models/acm-pca.json | 258 +- .../aws-models/amplifybackend.json | 103 +- .../aws-models/billingconductor.json | 4677 +++++++++++++++++ .../aws-models/chime-sdk-meetings.json | 27 + codegen/sdk-codegen/aws-models/chime.json | 19 +- .../aws-models/cognito-identity-provider.json | 154 +- .../aws-models/config-service.json | 12 +- codegen/sdk-codegen/aws-models/connect.json | 27 +- .../sdk-codegen/aws-models/dataexchange.json | 228 +- codegen/sdk-codegen/aws-models/ec2.json | 17 +- codegen/sdk-codegen/aws-models/ecr.json | 3 +- codegen/sdk-codegen/aws-models/ecs.json | 16 +- .../sdk-codegen/aws-models/elasticache.json | 4 +- codegen/sdk-codegen/aws-models/glue.json | 1131 +++- codegen/sdk-codegen/aws-models/kendra.json | 309 +- codegen/sdk-codegen/aws-models/keyspaces.json | 58 +- codegen/sdk-codegen/aws-models/lambda.json | 18 +- codegen/sdk-codegen/aws-models/location.json | 333 +- .../sdk-codegen/aws-models/mediaconnect.json | 148 + codegen/sdk-codegen/aws-models/outposts.json | 41 +- .../sdk-codegen/aws-models/quicksight.json | 305 +- codegen/sdk-codegen/aws-models/ram.json | 12 +- codegen/sdk-codegen/aws-models/rds.json | 1713 +++--- codegen/sdk-codegen/aws-models/robomaker.json | 33 +- .../sdk-codegen/aws-models/s3outposts.json | 142 +- .../aws-models/secrets-manager.json | 2 +- .../sdk-codegen/aws-models/ssm-incidents.json | 173 +- .../aws-models/timestream-query.json | 4 + .../aws-models/transcribe-streaming.json | 78 +- 29 files changed, 8539 insertions(+), 1506 deletions(-) create mode 100644 codegen/sdk-codegen/aws-models/billingconductor.json diff --git a/codegen/sdk-codegen/aws-models/acm-pca.json b/codegen/sdk-codegen/aws-models/acm-pca.json index 22d55c79b6450..330afe4afa9dd 100644 --- a/codegen/sdk-codegen/aws-models/acm-pca.json +++ b/codegen/sdk-codegen/aws-models/acm-pca.json @@ -31,6 +31,21 @@ "shapes": { "com.amazonaws.acmpca#ACMPrivateCA": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "ACM PCA", + "arnNamespace": "acm-pca", + "cloudFormationName": "ACMPCA", + "cloudTrailEventSource": "acmpca.amazonaws.com", + "endpointPrefix": "acm-pca" + }, + "aws.auth#sigv4": { + "name": "acm-pca" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "

This is the Amazon Web Services Private Certificate Authority API Reference. It provides descriptions,\n\t\t\tsyntax, and usage examples for each of the actions and data types involved in creating\n\t\t\tand managing a private certificate authority (CA) for your organization.

\n\t\t

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

\n\t\t

Each Amazon Web Services Private CA API operation has a quota that determines the number of times the\n\t\t\toperation can be called per second. Amazon Web Services Private CA throttles API requests at different rates\n\t\t\tdepending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid\n\t\t\trequest because the request exceeds the operation's quota for the number of requests per\n\t\t\tsecond. When a request is throttled, Amazon Web Services Private CA returns a ThrottlingException error. Amazon Web Services Private CA does not guarantee a minimum request\n\t\t\trate for APIs.

\n\n\t\t

To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase,\n\t\t\tlog into your Amazon Web Services account and visit the Service Quotas\n\t\t\tconsole.

", + "smithy.api#title": "AWS Certificate Manager Private Certificate Authority" + }, "version": "2017-08-22", "operations": [ { @@ -102,22 +117,7 @@ { "target": "com.amazonaws.acmpca#UpdateCertificateAuthority" } - ], - "traits": { - "aws.api#service": { - "sdkId": "ACM PCA", - "arnNamespace": "acm-pca", - "cloudFormationName": "ACMPCA", - "cloudTrailEventSource": "acmpca.amazonaws.com", - "endpointPrefix": "acm-pca" - }, - "aws.auth#sigv4": { - "name": "acm-pca" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

This is the ACM Private CA API Reference. It provides descriptions,\n\t\t\tsyntax, and usage examples for each of the actions and data types involved in creating\n\t\t\tand managing private certificate authorities (CA) for your organization.

\n\t\t

The documentation for each action shows the Query API request parameters and the XML\n\t\t\tresponse. Alternatively, you can use one of the AWS SDKs to access an API that's\n\t\t\ttailored to the programming language or platform that you're using. For more\n\t\t\tinformation, see AWS\n\t\t\tSDKs.

\n\t\t

Each ACM Private CA API operation has a quota that determines the number of times the operation\n\t\t\tcan be called per second. ACM Private CA throttles API requests at different rates depending\n\t\t\ton the operation. Throttling means that ACM Private CA rejects an otherwise valid request\n\t\t\tbecause the request exceeds the operation's quota for the number of requests per second.\n\t\t\tWhen a request is throttled, ACM Private CA returns a ThrottlingException error. ACM Private CA does not guarantee a minimum request\n\t\t\trate for APIs.

\n\n\t\t

To see an up-to-date list of your ACM Private CA quotas, or to request a quota increase,\n\t\t\tlog into your AWS account and visit the Service Quotas\n\t\t\tconsole.

", - "smithy.api#title": "AWS Certificate Manager Private Certificate Authority" - } + ] }, "com.amazonaws.acmpca#ASN1PrintableString64": { "type": "string", @@ -215,6 +215,12 @@ "traits": { "smithy.api#documentation": "

Typically a qualifier appended to the name of an individual. Examples include Jr. for\n\t\t\tjunior, Sr. for senior, and III for third.

" } + }, + "CustomAttributes": { + "target": "com.amazonaws.acmpca#CustomAttributeList", + "traits": { + "smithy.api#documentation": "

\n\t\t

Contains a sequence of one or more X.500 relative distinguished\n\t\t\tnames\n\t\t\t(RDNs),\n\t\t\teach of which consists of an object identifier (OID) and\n\t\t\ta\n\t\t\tvalue. For more information, see NIST’s definition of \n\t\t\tObject\n\t\t\t\tIdentifier\n\t\t\t\t(OID).

\n\t\t\n\t\t \n\t\t\t

Custom attributes cannot be used in combination with standard attributes.

\n\t\t " + } } }, "traits": { @@ -250,7 +256,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides access information used by the authorityInfoAccess and\n\t\t\t\tsubjectInfoAccess extensions described in RFC 5280.

" + "smithy.api#documentation": "

Provides access information used by the authorityInfoAccess and\n\t\t\t\tsubjectInfoAccess extensions described in RFC 5280.

" } }, "com.amazonaws.acmpca#AccessDescriptionList": { @@ -353,7 +359,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains X.509 certificate information to be placed in an issued certificate. An\n\t\t\t\tAPIPassthrough or APICSRPassthrough template variant must\n\t\t\tbe selected, or else this parameter is ignored.

\n\t\t

If conflicting or duplicate certificate information is supplied from other sources,\n\t\t\tACM Private CA applies order of\n\t\t\t\toperation rules to determine what information is used.

" + "smithy.api#documentation": "

Contains X.509 certificate information to be placed in an issued certificate. An\n\t\t\t\tAPIPassthrough or APICSRPassthrough template variant must\n\t\t\tbe selected, or else this parameter is ignored.

\n\t\t

If conflicting or duplicate certificate information is supplied from other sources,\n\t\t\tAmazon Web Services Private CA applies order of\n\t\t\t\toperation rules to determine what information is used.

" } }, "com.amazonaws.acmpca#Arn": { @@ -410,6 +416,16 @@ ] } }, + "com.amazonaws.acmpca#Base64String1To4096": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + }, + "smithy.api#pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$" + } + }, "com.amazonaws.acmpca#Boolean": { "type": "boolean" }, @@ -431,7 +447,7 @@ "OwnerAccount": { "target": "com.amazonaws.acmpca#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID that owns the certificate authority.

" + "smithy.api#documentation": "

The Amazon Web Services account ID that owns the certificate authority.

" } }, "CreatedAt": { @@ -491,7 +507,7 @@ "RevocationConfiguration": { "target": "com.amazonaws.acmpca#RevocationConfiguration", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

" } }, "RestorableUntil": { @@ -503,12 +519,12 @@ "KeyStorageSecurityStandard": { "target": "com.amazonaws.acmpca#KeyStorageSecurityStandard", "traits": { - "smithy.api#documentation": "

Defines a cryptographic key management compliance standard used for handling CA keys.

\n\t\t

Default: FIPS_140_2_LEVEL_3_OR_HIGHER

\n\t\t

Note: AWS Region ap-northeast-3 supports only FIPS_140_2_LEVEL_2_OR_HIGHER. You must\n\t\t\texplicitly specify this parameter and value when creating a CA in that Region.\n\t\t\tSpecifying a different value (or no value) results in an\n\t\t\t\tInvalidArgsException with the message \"A certificate authority cannot\n\t\t\tbe created in this region with the specified security standard.\"

" + "smithy.api#documentation": "

Defines a cryptographic key management compliance standard used for handling CA keys.

\n\t\t

Default: FIPS_140_2_LEVEL_3_OR_HIGHER

\n\t\t

Note: Amazon Web Services Region ap-northeast-3 supports only FIPS_140_2_LEVEL_2_OR_HIGHER. You must\n\t\t\texplicitly specify this parameter and value when creating a CA in that Region.\n\t\t\tSpecifying a different value (or no value) results in an\n\t\t\t\tInvalidArgsException with the message \"A certificate authority cannot\n\t\t\tbe created in this region with the specified security standard.\"

" } } }, "traits": { - "smithy.api#documentation": "

Contains information about your private certificate authority (CA). Your private CA\n\t\t\tcan issue and revoke X.509 digital certificates. Digital certificates verify that the\n\t\t\tentity named in the certificate Subject field owns or\n\t\t\tcontrols the public key contained in the Subject Public Key\n\t\t\t\tInfo field. Call the CreateCertificateAuthority action to create your private CA. You must then\n\t\t\tcall the GetCertificateAuthorityCertificate action to retrieve a private CA\n\t\t\tcertificate signing request (CSR). Sign the CSR with your ACM Private CA-hosted or on-premises\n\t\t\troot or subordinate CA certificate. Call the ImportCertificateAuthorityCertificate action to import the signed\n\t\t\tcertificate into AWS Certificate Manager (ACM).

" + "smithy.api#documentation": "

Contains information about your private certificate authority (CA). Your private CA\n\t\t\tcan issue and revoke X.509 digital certificates. Digital certificates verify that the\n\t\t\tentity named in the certificate Subject field owns or\n\t\t\tcontrols the public key contained in the Subject Public Key\n\t\t\t\tInfo field. Call the CreateCertificateAuthority action to create your private CA. You must then\n\t\t\tcall the GetCertificateAuthorityCertificate action to retrieve a private CA\n\t\t\tcertificate signing request (CSR). Sign the CSR with your Amazon Web Services Private CA-hosted or\n\t\t\ton-premises root or subordinate CA certificate. Call the ImportCertificateAuthorityCertificate action to import the signed\n\t\t\tcertificate into Certificate Manager (ACM).

" } }, "com.amazonaws.acmpca#CertificateAuthorityConfiguration": { @@ -689,7 +705,7 @@ } ], "traits": { - "smithy.api#documentation": "

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

\n\t\t

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

\n \n

Both PCA and the IAM principal must have permission to write to\n the S3 bucket that you specify. If the IAM principal making the call\n does not have permission to write to the bucket, then an exception is\n thrown. For more information, see Configure\n Access to ACM Private CA.

\n ", + "smithy.api#documentation": "

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

\n\t\t

Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption. \n For more information, see Encrypting Your\n\t\t\tCRLs.

\n\t\t \n

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

\n ", "smithy.api#idempotent": {} } }, @@ -722,7 +738,7 @@ } ], "traits": { - "smithy.api#documentation": "

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

\n \n

Both PCA and the IAM principal must have permission to write to\n the S3 bucket that you specify. If the IAM principal making the call\n does not have permission to write to the bucket, then an exception is\n thrown. For more information, see Configure\n Access to ACM Private CA.

\n \n\t\t \n\t\t

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

", + "smithy.api#documentation": "

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

\n\t\t \n

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

\n \n\t\t

Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption. \n For more information, see Encrypting Your Audit\n\t\t\t\tReports.

\n\t\t \n\t\t\t

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

\n\t\t ", "smithy.api#idempotent": {} } }, @@ -782,7 +798,7 @@ "RevocationConfiguration": { "target": "com.amazonaws.acmpca#RevocationConfiguration", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

" } }, "CertificateAuthorityType": { @@ -795,7 +811,7 @@ "IdempotencyToken": { "target": "com.amazonaws.acmpca#IdempotencyToken", "traits": { - "smithy.api#documentation": "

Custom string that can be used to distinguish between calls to the CreateCertificateAuthority action. Idempotency tokens for\n\t\t\t\tCreateCertificateAuthority time out after five\n\t\t\tminutes. Therefore, if you call CreateCertificateAuthority multiple times with the same idempotency\n\t\t\ttoken within five minutes, ACM Private CA recognizes that you are requesting only certificate\n\t\t\tauthority and will issue only one. If you change the idempotency token for each call,\n\t\t\tPCA recognizes that you are requesting multiple certificate authorities.

" + "smithy.api#documentation": "

Custom string that can be used to distinguish between calls to the CreateCertificateAuthority action. Idempotency tokens for\n\t\t\t\tCreateCertificateAuthority time out after five\n\t\t\tminutes. Therefore, if you call CreateCertificateAuthority multiple times with the same idempotency\n\t\t\ttoken within five minutes, Amazon Web Services Private CA recognizes that you are requesting only\n\t\t\tcertificate authority and will issue only one. If you change the idempotency token for\n\t\t\teach call, PCA recognizes that you are requesting multiple certificate\n\t\t\tauthorities.

" } }, "KeyStorageSecurityStandard": { @@ -849,7 +865,7 @@ } ], "traits": { - "smithy.api#documentation": "

Grants one or more permissions on a private CA to the AWS Certificate Manager (ACM) service\n\t\t\tprincipal (acm.amazonaws.com). These permissions allow ACM to issue and\n\t\t\trenew ACM certificates that reside in the same AWS account as the CA.

\n\t\t

You can list current permissions with the ListPermissions action and\n\t\t\trevoke them with the DeletePermission action.

\n\t\t

\n About Permissions\n

\n " + "smithy.api#documentation": "

Grants one or more permissions on a private CA to the Certificate Manager (ACM) service\n\t\t\tprincipal (acm.amazonaws.com). These permissions allow ACM to issue and\n\t\t\trenew ACM certificates that reside in the same Amazon Web Services account as the CA.

\n\t\t

You can list current permissions with the ListPermissions action and\n\t\t\trevoke them with the DeletePermission action.

\n\t\t

\n About Permissions\n

\n " } }, "com.amazonaws.acmpca#CreatePermissionRequest": { @@ -865,7 +881,7 @@ "Principal": { "target": "com.amazonaws.acmpca#Principal", "traits": { - "smithy.api#documentation": "

The AWS service or identity that receives the permission. At this time, the only\n\t\t\tvalid principal is acm.amazonaws.com.

", + "smithy.api#documentation": "

The Amazon Web Services service or identity that receives the permission. At this time, the only\n\t\t\tvalid principal is acm.amazonaws.com.

", "smithy.api#required": {} } }, @@ -878,7 +894,7 @@ "Actions": { "target": "com.amazonaws.acmpca#ActionList", "traits": { - "smithy.api#documentation": "

The actions that the specified AWS service principal can use. These include\n\t\t\t\tIssueCertificate, GetCertificate, and\n\t\t\t\tListPermissions.

", + "smithy.api#documentation": "

The actions that the specified Amazon Web Services service principal can use. These include\n\t\t\t\tIssueCertificate, GetCertificate, and\n\t\t\t\tListPermissions.

", "smithy.api#required": {} } } @@ -911,7 +927,7 @@ "S3BucketName": { "target": "com.amazonaws.acmpca#String3To255", "traits": { - "smithy.api#documentation": "

Name of the S3 bucket that contains the CRL. If you do not provide a value for the\n\t\t\t\tCustomCname argument, the name of your S3 bucket\n\t\t\tis placed into the CRL Distribution Points extension of\n\t\t\tthe issued certificate. You can change the name of your bucket by calling the UpdateCertificateAuthority operation. You must specify a bucket\n\t\t\t\tpolicy that allows ACM Private CA to write the CRL to your bucket.

" + "smithy.api#documentation": "

Name of the S3 bucket that contains the CRL. If you do not provide a value for the\n\t\t\t\tCustomCname argument, the name of your S3 bucket\n\t\t\tis placed into the CRL Distribution Points extension of\n\t\t\tthe issued certificate. You can change the name of your bucket by calling the UpdateCertificateAuthority operation. You must specify a bucket\n\t\t\t\tpolicy that allows Amazon Web Services Private CA to write the CRL to your bucket.

" } }, "S3ObjectAcl": { @@ -922,7 +938,7 @@ } }, "traits": { - "smithy.api#documentation": "

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

\n\t\t

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

\n\t\t

Your private CA uses the value in the ExpirationInDays\n\t\t\tparameter to calculate the nextUpdate field in the CRL.\n\t\t\tThe CRL is refreshed at 1/2 the age of next update or when a certificate is revoked.\n\t\t\tWhen a certificate is revoked, it is recorded in the next CRL that is generated and in\n\t\t\tthe next audit report. Only time valid certificates are listed in the CRL. Expired\n\t\t\tcertificates are not included.

\n\t\t\n\t\t

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

\n\t\t\n\t\t

CRLs contain the following fields:

\n\t\t \n\t\t

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

\n\t\t

\n openssl crl -inform DER -text -in crl_path\n\t\t\t-noout\n

\n\t\t

For more information, see Planning a certificate revocation list (CRL) \n\t\t\tin the AWS Certificate Manager Private Certificate Authority (PCA) User Guide\n

" + "smithy.api#documentation": "

Contains configuration information for a certificate revocation list (CRL). Your\n\t\t\tprivate certificate authority (CA) creates base CRLs. Delta CRLs are not supported. You\n\t\t\tcan enable CRLs for your new or an existing private CA by setting the Enabled parameter to true. Your private CA\n\t\t\twrites CRLs to an S3 bucket that you specify in the S3BucketName parameter. You can hide the name of your bucket by\n\t\t\tspecifying a value for the CustomCname parameter. Your\n\t\t\tprivate CA copies the CNAME or the S3 bucket name to the CRL\n\t\t\t\tDistribution Points extension of each certificate it issues. Your S3\n\t\t\tbucket policy must give write permission to Amazon Web Services Private CA.

\n\t\t

Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption. \n For more information, see Encrypting Your\n\t\t\tCRLs.

\n\t\t

Your private CA uses the value in the ExpirationInDays\n\t\t\tparameter to calculate the nextUpdate field in the CRL.\n\t\t\tThe CRL is refreshed prior to a certificate's expiration date or when a certificate is\n\t\t\trevoked. When a certificate is revoked, it appears in the CRL until the certificate\n\t\t\texpires, and then in one additional CRL after expiration, and it always appears in the\n\t\t\taudit report.

\n\n\t\t

A CRL is typically updated approximately 30 minutes after a certificate \n\tis revoked. If for any reason a CRL update fails, Amazon Web Services Private CA makes further attempts \n\tevery 15 minutes.

\n\n\t\t

CRLs contain the following fields:

\n\t\t \n\t\t

Certificate revocation lists created by Amazon Web Services Private CA are DER-encoded. You can use the\n\t\t\tfollowing OpenSSL command to list a CRL.

\n\t\t

\n openssl crl -inform DER -text -in crl_path\n\t\t\t-noout\n

\n\t\t

For more information, see Planning a certificate revocation list\n\t\t\t\t(CRL) in the Amazon Web Services Private Certificate Authority User Guide\n

" } }, "com.amazonaws.acmpca#CsrBlob": { @@ -949,7 +965,7 @@ "SubjectInformationAccess": { "target": "com.amazonaws.acmpca#AccessDescriptionList", "traits": { - "smithy.api#documentation": "

For CA certificates, provides a path to additional information pertaining to the CA,\n\t\t\tsuch as revocation and policy. For more information, see Subject Information\n\t\t\t\tAccess in RFC 5280.

" + "smithy.api#documentation": "

For CA certificates, provides a path to additional information pertaining to the CA,\n\t\t\tsuch as revocation and policy. For more information, see Subject\n\t\t\t\tInformation Access in RFC 5280.

" } } }, @@ -957,6 +973,81 @@ "smithy.api#documentation": "

Describes the certificate extensions to be added to the certificate signing request\n\t\t\t(CSR).

" } }, + "com.amazonaws.acmpca#CustomAttribute": { + "type": "structure", + "members": { + "ObjectIdentifier": { + "target": "com.amazonaws.acmpca#CustomObjectIdentifier", + "traits": { + "smithy.api#documentation": "

Specifies the object identifier (OID) of the attribute type of\n\t\t\tthe\n\t\t\trelative distinguished name\n\t\t\t(RDN).

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.acmpca#String1To256", + "traits": { + "smithy.api#documentation": "

\n\t\t

Specifies the attribute value of relative distinguished name\n\t\t\t(RDN).

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines the X.500 relative distinguished name (RDN).

" + } + }, + "com.amazonaws.acmpca#CustomAttributeList": { + "type": "list", + "member": { + "target": "com.amazonaws.acmpca#CustomAttribute" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30 + } + } + }, + "com.amazonaws.acmpca#CustomExtension": { + "type": "structure", + "members": { + "ObjectIdentifier": { + "target": "com.amazonaws.acmpca#CustomObjectIdentifier", + "traits": { + "smithy.api#documentation": "

\n\t\t

Specifies the object identifier (OID) of the X.509 extension. For more information,\n\t\t\tsee the\n\t\t\t\tGlobal OID reference\n\t\t\t\tdatabase.\n\t\t

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.acmpca#Base64String1To4096", + "traits": { + "smithy.api#documentation": "

\n\t\t

Specifies the base64-encoded value of the X.509\n\t\t\textension.

", + "smithy.api#required": {} + } + }, + "Critical": { + "target": "com.amazonaws.acmpca#Boolean", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

\n\t\t

Specifies the critical flag of\n\t\t\tthe\n\t\t\tX.509\n\t\t\textension.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n\t\t

Specifies the X.509 extension information for a\n\t\t\tcertificate.

\n\t\t

Extensions present in CustomExtensions follow the\n\t\t\t\tApiPassthrough\n\t\t\t template rules.

" + } + }, + "com.amazonaws.acmpca#CustomExtensionList": { + "type": "list", + "member": { + "target": "com.amazonaws.acmpca#CustomExtension" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, "com.amazonaws.acmpca#CustomObjectIdentifier": { "type": "string", "traits": { @@ -987,7 +1078,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a private certificate authority (CA). You must provide the Amazon Resource\n\t\t\tName (ARN) of the private CA that you want to delete. You can find the ARN by calling\n\t\t\tthe ListCertificateAuthorities action.

\n\t\t \n\t\t\t

Deleting a CA will invalidate other CAs and certificates below it in your CA\n\t\t\t\thierarchy.

\n\t\t \n\t\t

Before you can delete a CA that you have created and activated, you must disable it.\n\t\t\tTo do this, call the UpdateCertificateAuthority action and set the CertificateAuthorityStatus parameter to DISABLED.

\n\t\t

Additionally, you can delete a CA if you are waiting for it to be created (that is,\n\t\t\tthe status of the CA is CREATING). You can also delete it if the CA has\n\t\t\tbeen created but you haven't yet imported the signed certificate into ACM Private CA (that is,\n\t\t\tthe status of the CA is PENDING_CERTIFICATE).

\n\t\t

When you successfully call DeleteCertificateAuthority, the CA's status changes to\n\t\t\tDELETED. However, the CA won't be permanently deleted until the restoration\n\t\t\tperiod has passed. By default, if you do not set the\n\t\t\t\tPermanentDeletionTimeInDays parameter, the CA remains restorable for 30\n\t\t\tdays. You can set the parameter from 7 to 30 days. The DescribeCertificateAuthority action returns the time remaining in the\n\t\t\trestoration window of a private CA in the DELETED state. To restore an\n\t\t\teligible CA, call the RestoreCertificateAuthority action.

" + "smithy.api#documentation": "

Deletes a private certificate authority (CA). You must provide the Amazon Resource\n\t\t\tName (ARN) of the private CA that you want to delete. You can find the ARN by calling\n\t\t\tthe ListCertificateAuthorities action.

\n\t\t \n\t\t\t

Deleting a CA will invalidate other CAs and certificates below it in your CA\n\t\t\t\thierarchy.

\n\t\t \n\t\t

Before you can delete a CA that you have created and activated, you must disable it.\n\t\t\tTo do this, call the UpdateCertificateAuthority action and set the CertificateAuthorityStatus parameter to DISABLED.

\n\t\t

Additionally, you can delete a CA if you are waiting for it to be created (that is,\n\t\t\tthe status of the CA is CREATING). You can also delete it if the CA has\n\t\t\tbeen created but you haven't yet imported the signed certificate into Amazon Web Services Private CA (that\n\t\t\tis, the status of the CA is PENDING_CERTIFICATE).

\n\t\t

When you successfully call DeleteCertificateAuthority, the CA's status changes to\n\t\t\tDELETED. However, the CA won't be permanently deleted until the restoration\n\t\t\tperiod has passed. By default, if you do not set the\n\t\t\t\tPermanentDeletionTimeInDays parameter, the CA remains restorable for 30\n\t\t\tdays. You can set the parameter from 7 to 30 days. The DescribeCertificateAuthority action returns the time remaining in the\n\t\t\trestoration window of a private CA in the DELETED state. To restore an\n\t\t\teligible CA, call the RestoreCertificateAuthority action.

" } }, "com.amazonaws.acmpca#DeleteCertificateAuthorityRequest": { @@ -1028,7 +1119,7 @@ } ], "traits": { - "smithy.api#documentation": "

Revokes permissions on a private CA granted to the AWS Certificate Manager (ACM) service principal\n\t\t\t(acm.amazonaws.com).

\n\t\t

These permissions allow ACM to issue and renew ACM certificates that reside in the\n\t\t\tsame AWS account as the CA. If you revoke these permissions, ACM will no longer\n\t\t\trenew the affected certificates automatically.

\n\t\t

Permissions can be granted with the CreatePermission action and\n\t\t\tlisted with the ListPermissions action.

\n

\n About Permissions\n

\n " + "smithy.api#documentation": "

Revokes permissions on a private CA granted to the Certificate Manager (ACM) service principal\n\t\t\t(acm.amazonaws.com).

\n\t\t

These permissions allow ACM to issue and renew ACM certificates that reside in the\n\t\t\tsame Amazon Web Services account as the CA. If you revoke these permissions, ACM will no longer\n\t\t\trenew the affected certificates automatically.

\n\t\t

Permissions can be granted with the CreatePermission action and\n\t\t\tlisted with the ListPermissions action.

\n\t\t

\n About Permissions\n

\n " } }, "com.amazonaws.acmpca#DeletePermissionRequest": { @@ -1044,14 +1135,14 @@ "Principal": { "target": "com.amazonaws.acmpca#Principal", "traits": { - "smithy.api#documentation": "

The AWS service or identity that will have its CA permissions revoked. At this time,\n\t\t\tthe only valid service principal is acm.amazonaws.com\n

", + "smithy.api#documentation": "

The Amazon Web Services service or identity that will have its CA permissions revoked. At this time,\n\t\t\tthe only valid service principal is acm.amazonaws.com\n

", "smithy.api#required": {} } }, "SourceAccount": { "target": "com.amazonaws.acmpca#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account that calls this action.

" + "smithy.api#documentation": "

The Amazon Web Services account that calls this action.

" } } } @@ -1082,7 +1173,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the resource-based policy attached to a private CA. Deletion will remove any\n\t\t\taccess that the policy has granted. If there is no policy attached to the private CA,\n\t\t\tthis action will return successful.

\n\t\t

If you delete a policy that was applied through AWS Resource Access Manager (RAM), the\n\t\t\tCA will be removed from all shares in which it was included.

\n\t\t

The AWS Certificate Manager Service Linked Role that the policy supports is not affected when you\n\t\t\tdelete the policy.

\n\t\t

The current policy can be shown with GetPolicy and updated with PutPolicy.

\n\t\t

\n About Policies\n

\n " + "smithy.api#documentation": "

Deletes the resource-based policy attached to a private CA. Deletion will remove any\n\t\t\taccess that the policy has granted. If there is no policy attached to the private CA,\n\t\t\tthis action will return successful.

\n\t\t

If you delete a policy that was applied through Amazon Web Services Resource Access Manager (RAM),\n\t\t\tthe CA will be removed from all shares in which it was included.

\n\t\t

The Certificate Manager Service Linked Role that the policy supports is not affected when you\n\t\t\tdelete the policy.

\n\t\t

The current policy can be shown with GetPolicy and updated with PutPolicy.

\n\t\t

\n About Policies\n

\n " } }, "com.amazonaws.acmpca#DeletePolicyRequest": { @@ -1114,7 +1205,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists information about your private certificate authority (CA) or one that has been\n\t\t\tshared with you. You specify the private CA on input by its ARN (Amazon Resource Name).\n\t\t\tThe output contains the status of your CA. This can be any of the following:

\n\t\t " + "smithy.api#documentation": "

Lists information about your private certificate authority (CA) or one that has been\n\t\t\tshared with you. You specify the private CA on input by its ARN (Amazon Resource Name).\n\t\t\tThe output contains the status of your CA. This can be any of the following:

\n\t\t " } }, "com.amazonaws.acmpca#DescribeCertificateAuthorityAuditReport": { @@ -1257,7 +1348,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes an Electronic Data Interchange (EDI) entity as described in as defined in\n\t\t\t\tSubject Alternative Name in\n\t\t\tRFC 5280.

" + "smithy.api#documentation": "

Describes an Electronic Data Interchange (EDI) entity as described in as defined in\n\t\t\t\tSubject Alternative\n\t\t\t\tName in RFC 5280.

" } }, "com.amazonaws.acmpca#ExtendedKeyUsage": { @@ -1266,7 +1357,7 @@ "ExtendedKeyUsageType": { "target": "com.amazonaws.acmpca#ExtendedKeyUsageType", "traits": { - "smithy.api#documentation": "

Specifies a standard ExtendedKeyUsage as defined as in RFC 5280.

" + "smithy.api#documentation": "

Specifies a standard ExtendedKeyUsage as defined as in RFC\n\t\t\t\t5280.

" } }, "ExtendedKeyUsageObjectIdentifier": { @@ -1358,6 +1449,12 @@ "traits": { "smithy.api#documentation": "

The subject alternative name extension allows identities to be bound to the subject of\n\t\t\tthe certificate. These identities may be included in addition to or in place of the\n\t\t\tidentity in the subject field of the certificate.

" } + }, + "CustomExtensions": { + "target": "com.amazonaws.acmpca#CustomExtensionList", + "traits": { + "smithy.api#documentation": "

\n\t\t

Contains a sequence of one or more X.509 extensions, each of which consists of an\n\t\t\tobject identifier (OID), a base64-encoded\n\t\t\tvalue,\n\t\t\tand the\n\t\t\tcritical flag.\n\t\t\tFor\n\t\t\tmore information, see the Global OID reference\n\t\t\t\tdatabase.\n

\t\t\n\t\t\n\t\t \n\t\t\t

The OID value of a CustomExtension must not\n\t\t\t\tmatch the OID of a predefined extension.

\n\t\t " + } } }, "traits": { @@ -1395,7 +1492,7 @@ "Rfc822Name": { "target": "com.amazonaws.acmpca#String256", "traits": { - "smithy.api#documentation": "

Represents GeneralName as an RFC 822 email address.

" + "smithy.api#documentation": "

Represents GeneralName as an RFC 822 email\n\t\t\taddress.

" } }, "DnsName": { @@ -1433,7 +1530,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes an ASN.1 X.400 GeneralName as defined in RFC 5280. Only one of the\n\t\t\tfollowing naming options should be provided. Providing more than one option results in\n\t\t\tan InvalidArgsException error.

" + "smithy.api#documentation": "

Describes an ASN.1 X.400 GeneralName as defined in RFC 5280. Only one of\n\t\t\tthe following naming options should be provided. Providing more than one option results\n\t\t\tin an InvalidArgsException error.

" } }, "com.amazonaws.acmpca#GeneralNameList": { @@ -1575,7 +1672,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the certificate signing request (CSR) for your private certificate authority\n\t\t\t(CA). The CSR is created when you call the CreateCertificateAuthority action. Sign the CSR with your ACM Private CA-hosted or\n\t\t\ton-premises root or subordinate CA. Then import the signed certificate back into ACM Private CA\n\t\t\tby calling the ImportCertificateAuthorityCertificate action. The CSR is returned as a\n\t\t\tbase64 PEM-encoded string.

", + "smithy.api#documentation": "

Retrieves the certificate signing request (CSR) for your private certificate authority\n\t\t\t(CA). The CSR is created when you call the CreateCertificateAuthority action. Sign the CSR with your Amazon Web Services Private CA-hosted\n\t\t\tor on-premises root or subordinate CA. Then import the signed certificate back into\n\t\t\tAmazon Web Services Private CA by calling the ImportCertificateAuthorityCertificate action. The CSR is returned as a\n\t\t\tbase64 PEM-encoded string.

", "smithy.waiters#waitable": { "CertificateAuthorityCSRCreated": { "documentation": "Wait until a Certificate Authority CSR is created", @@ -1680,7 +1777,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the resource-based policy attached to a private CA. If either the private CA\n\t\t\tresource or the policy cannot be found, this action returns a\n\t\t\t\tResourceNotFoundException.

\n\t\t

The policy can be attached or updated with PutPolicy and removed with DeletePolicy.

\n

\n About Policies\n

\n " + "smithy.api#documentation": "

Retrieves the resource-based policy attached to a private CA. If either the private CA\n\t\t\tresource or the policy cannot be found, this action returns a\n\t\t\t\tResourceNotFoundException.

\n\t\t

The policy can be attached or updated with PutPolicy and removed with DeletePolicy.

\n\t\t

\n About Policies\n

\n " } }, "com.amazonaws.acmpca#GetPolicyRequest": { @@ -1751,7 +1848,7 @@ } ], "traits": { - "smithy.api#documentation": "

Imports a signed private CA certificate into ACM Private CA. This action is used when you are\n\t\t\tusing a chain of trust whose root is located outside ACM Private CA. Before you can call this\n\t\t\taction, the following preparations must in place:

\n\t\t
    \n
  1. \n\t\t\t\t

    In ACM Private CA, call the CreateCertificateAuthority action to create the private CA that you\n\t\t\t\t\tplan to back with the imported certificate.

    \n\t\t\t
    2. \n
  2. \n\t\t\t\t

    Call the GetCertificateAuthorityCsr action to generate a certificate signing\n\t\t\t\t\trequest (CSR).

    \n\t\t\t
    3. \n
  3. \n\t\t\t\t

    Sign the CSR using a root or intermediate CA hosted by either an on-premises\n\t\t\t\t\tPKI hierarchy or by a commercial CA.

    \n\t\t\t
    4. \n
  4. \n\t\t\t\t

    Create a certificate chain and copy the signed certificate and the certificate\n\t\t\t\t\tchain to your working directory.

    \n\t\t\t
    5. \n
\n\t\t

ACM Private CA supports three scenarios for installing a CA certificate:

\n\t\t \n\t\t

The following additional requirements apply when you import a CA certificate.

\n\t\t \n\t\t

\n Enforcement of Critical Constraints\n

\n\t\t

ACM Private CA allows the following extensions to be marked critical in the imported CA\n\t\t\tcertificate or chain.

\n\t\t \n\t\t

ACM Private CA rejects the following extensions when they are marked critical in an imported CA\n\t\t\tcertificate or chain.

\n\t\t " + "smithy.api#documentation": "

Imports a signed private CA certificate into Amazon Web Services Private CA. This action is used when you\n\t\t\tare using a chain of trust whose root is located outside Amazon Web Services Private CA. Before you can call\n\t\t\tthis action, the following preparations must in place:

\n\t\t
    \n
  1. \n\t\t\t\t

    In Amazon Web Services Private CA, call the CreateCertificateAuthority action to create the private CA that you\n\t\t\t\t\tplan to back with the imported certificate.

    \n\t\t\t
    2. \n
  2. \n\t\t\t\t

    Call the GetCertificateAuthorityCsr action to generate a certificate signing\n\t\t\t\t\trequest (CSR).

    \n\t\t\t
    3. \n
  3. \n\t\t\t\t

    Sign the CSR using a root or intermediate CA hosted by either an on-premises\n\t\t\t\t\tPKI hierarchy or by a commercial CA.

    \n\t\t\t
    4. \n
  4. \n\t\t\t\t

    Create a certificate chain and copy the signed certificate and the certificate\n\t\t\t\t\tchain to your working directory.

    \n\t\t\t
    5. \n
\n\t\t

Amazon Web Services Private CA supports three scenarios for installing a CA certificate:

\n\t\t \n\t\t

The following additional requirements apply when you import a CA certificate.

\n\t\t \n\t\t

\n Enforcement of Critical Constraints\n

\n\t\t

Amazon Web Services Private CA allows the following extensions to be marked critical in the imported CA\n\t\t\tcertificate or chain.

\n\t\t \n\t\t

Amazon Web Services Private CA rejects the following extensions when they are marked critical in an\n\t\t\timported CA certificate or chain.

\n\t\t " } }, "com.amazonaws.acmpca#ImportCertificateAuthorityCertificateRequest": { @@ -1774,7 +1871,7 @@ "CertificateChain": { "target": "com.amazonaws.acmpca#CertificateChainBlob", "traits": { - "smithy.api#documentation": "

A PEM-encoded file that contains all of your certificates, other than the certificate\n\t\t\tyou're importing, chaining up to your root CA. Your ACM Private CA-hosted or on-premises root\n\t\t\tcertificate is the last in the chain, and each certificate in the chain signs the one\n\t\t\tpreceding.

\n\t\t

This parameter must be supplied when you import a subordinate CA. When you import a\n\t\t\troot CA, there is no chain.

" + "smithy.api#documentation": "

A PEM-encoded file that contains all of your certificates, other than the certificate\n\t\t\tyou're importing, chaining up to your root CA. Your Amazon Web Services Private CA-hosted or on-premises\n\t\t\troot certificate is the last in the chain, and each certificate in the chain signs the\n\t\t\tone preceding.

\n\t\t

This parameter must be supplied when you import a subordinate CA. When you import a\n\t\t\troot CA, there is no chain.

" } } } @@ -1902,7 +1999,7 @@ } ], "traits": { - "smithy.api#documentation": "

Uses your private certificate authority (CA), or one that has been shared with you, to\n\t\t\tissue a client certificate. This action returns the Amazon Resource Name (ARN) of the\n\t\t\tcertificate. You can retrieve the certificate by calling the GetCertificate action and\n\t\t\tspecifying the ARN.

\n\t\t \n\t\t\t

You cannot use the ACM ListCertificateAuthorities action to retrieve the ARNs of the\n\t\t\t\tcertificates that you issue by using ACM Private CA.

\n\t\t ", + "smithy.api#documentation": "

Uses your private certificate authority (CA), or one that has been shared with you, to\n\t\t\tissue a client certificate. This action returns the Amazon Resource Name (ARN) of the\n\t\t\tcertificate. You can retrieve the certificate by calling the GetCertificate action and\n\t\t\tspecifying the ARN.

\n\t\t \n\t\t\t

You cannot use the ACM ListCertificateAuthorities action to retrieve the ARNs of the\n\t\t\t\tcertificates that you issue by using Amazon Web Services Private CA.

\n\t\t ", "smithy.api#idempotent": {} } }, @@ -1912,7 +2009,7 @@ "ApiPassthrough": { "target": "com.amazonaws.acmpca#ApiPassthrough", "traits": { - "smithy.api#documentation": "

Specifies X.509 certificate information to be included in the issued certificate. An\n\t\t\t\tAPIPassthrough or APICSRPassthrough template variant must\n\t\t\tbe selected, or else this parameter is ignored. For more information about using these\n\t\t\ttemplates, see Understanding Certificate Templates.

\n\t\t

If conflicting or duplicate certificate information is supplied during certificate\n\t\t\tissuance, ACM Private CA applies order of\n\t\t\t\toperation rules to determine what information is used.

" + "smithy.api#documentation": "

Specifies X.509 certificate information to be included in the issued certificate. An\n\t\t\t\tAPIPassthrough or APICSRPassthrough template variant must\n\t\t\tbe selected, or else this parameter is ignored. For more information about using these\n\t\t\ttemplates, see Understanding Certificate Templates.

\n\t\t

If conflicting or duplicate certificate information is supplied during certificate\n\t\t\tissuance, Amazon Web Services Private CA applies order of\n\t\t\t\toperation rules to determine what information is used.

" } }, "CertificateAuthorityArn": { @@ -1925,40 +2022,40 @@ "Csr": { "target": "com.amazonaws.acmpca#CsrBlob", "traits": { - "smithy.api#documentation": "

The certificate signing request (CSR) for the certificate you want to issue. As an\n\t\t\texample, you can use the following OpenSSL command to create the CSR and a 2048 bit RSA\n\t\t\tprivate key.

\n\t\t

\n\t\t\t openssl req -new -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem\n\t\t\t\t-out csr/test_cert_.csr\n\t\t

\n\t\t

If you have a configuration file, you can then use the following OpenSSL command. The\n\t\t\t\tusr_cert block in the configuration file contains your X509 version 3\n\t\t\textensions.

\n\t\t

\n openssl req -new -config openssl_rsa.cnf -extensions usr_cert -newkey rsa:2048\n\t\t\t\t-days -365 -keyout private/test_cert_priv_key.pem -out\n\t\t\tcsr/test_cert_.csr\n

\n\t\t

Note: A CSR must provide either a subject name or a\n\t\t\t\tsubject alternative name or the request will be rejected.\n\t\t

", + "smithy.api#documentation": "

The certificate signing request (CSR) for the certificate you want to issue. As an\n\t\t\texample, you can use the following OpenSSL command to create the CSR and a 2048 bit RSA\n\t\t\tprivate key.

\n\t\t

\n\t\t\t openssl req -new -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem\n\t\t\t\t-out csr/test_cert_.csr\n\t\t

\n\t\t

If you have a configuration file, you can then use the following OpenSSL command. The\n\t\t\t\tusr_cert block in the configuration file contains your X509 version 3\n\t\t\textensions.

\n\t\t

\n openssl req -new -config openssl_rsa.cnf -extensions usr_cert -newkey rsa:2048\n\t\t\t\t-days 365 -keyout private/test_cert_priv_key.pem -out\n\t\t\tcsr/test_cert_.csr\n

\n\t\t

Note: A CSR must provide either a subject name or a\n\t\t\t\tsubject alternative name or the request will be rejected.\n\t\t

", "smithy.api#required": {} } }, "SigningAlgorithm": { "target": "com.amazonaws.acmpca#SigningAlgorithm", "traits": { - "smithy.api#documentation": "

The name of the algorithm that will be used to sign the certificate to be issued.

\n\t\t

This parameter should not be confused with the SigningAlgorithm parameter\n\t\t\tused to sign a CSR in the CreateCertificateAuthority action.

", + "smithy.api#documentation": "

The name of the algorithm that will be used to sign the certificate to be issued.

\n\t\t

This parameter should not be confused with the SigningAlgorithm parameter\n\t\t\tused to sign a CSR in the CreateCertificateAuthority action.

\n\t\t \n\t\t\t

The specified signing algorithm family (RSA or ECDSA) much match the algorithm\n\t\t\t\tfamily of the CA's secret key.

\n\t\t ", "smithy.api#required": {} } }, "TemplateArn": { "target": "com.amazonaws.acmpca#Arn", "traits": { - "smithy.api#documentation": "

Specifies a custom configuration template to use when issuing a certificate. If this\n\t\t\tparameter is not provided, ACM Private CA defaults to the EndEntityCertificate/V1\n\t\t\ttemplate. For CA certificates, you should choose the shortest path length that meets\n\t\t\tyour needs. The path length is indicated by the PathLenN portion of\n\t\t\tthe ARN, where N is the CA depth.

\n\t\t

Note: The CA depth configured on a subordinate CA certificate must not exceed the\n\t\t\tlimit set by its parents in the CA hierarchy.

\n\t\t

For a list of TemplateArn values supported by ACM Private CA, see Understanding Certificate\n\t\t\t\tTemplates.

" + "smithy.api#documentation": "

Specifies a custom configuration template to use when issuing a certificate. If this\n\t\t\tparameter is not provided, Amazon Web Services Private CA defaults to the\n\t\t\t\tEndEntityCertificate/V1 template. For CA certificates, you should\n\t\t\tchoose the shortest path length that meets your needs. The path length is indicated by\n\t\t\tthe PathLenN portion of the ARN, where N is\n\t\t\tthe CA\n\t\t\t\tdepth.

\n\t\t

Note: The CA depth configured on a subordinate CA certificate must not exceed the\n\t\t\tlimit set by its parents in the CA hierarchy.

\n\t\t

For a list of TemplateArn values supported by Amazon Web Services Private CA, see Understanding Certificate\n\t\t\t\tTemplates.

" } }, "Validity": { "target": "com.amazonaws.acmpca#Validity", "traits": { - "smithy.api#documentation": "

Information describing the end of the validity period of the certificate. This\n\t\t\tparameter sets the “Not After” date for the certificate.

\n\t\t

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

\n\t\t

This value is unaffected when ValidityNotBefore is also specified. For\n\t\t\texample, if Validity is set to 20 days in the future, the certificate will\n\t\t\texpire 20 days from issuance time regardless of the ValidityNotBefore\n\t\t\tvalue.

\n\t\t

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

", + "smithy.api#documentation": "

Information describing the end of the validity period of the certificate. This\n\t\t\tparameter sets the “Not After” date for the certificate.

\n\t\t

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

\n\t\t

This value is unaffected when ValidityNotBefore is also specified. For\n\t\t\texample, if Validity is set to 20 days in the future, the certificate will\n\t\t\texpire 20 days from issuance time regardless of the ValidityNotBefore\n\t\t\tvalue.

\n\t\t

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

", "smithy.api#required": {} } }, "ValidityNotBefore": { "target": "com.amazonaws.acmpca#Validity", "traits": { - "smithy.api#documentation": "

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

\n\t\t

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

\n\t\t

Unlike the Validity parameter, the ValidityNotBefore\n\t\t\tparameter is optional.

\n\t\t

The ValidityNotBefore value is expressed as an explicit date and time,\n\t\t\tusing the Validity type value ABSOLUTE. For more information,\n\t\t\tsee Validity in this API reference and Validity in RFC\n\t\t\t5280.

" + "smithy.api#documentation": "

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

\n\t\t

By default, when issuing a certificate, Amazon Web Services Private CA sets the \"Not Before\" date to the\n\t\t\tissuance time minus 60 minutes. This compensates for clock inconsistencies across\n\t\t\tcomputer systems. The ValidityNotBefore parameter can be used to customize\n\t\t\tthe “Not Before” value.

\n\t\t

Unlike the Validity parameter, the ValidityNotBefore\n\t\t\tparameter is optional.

\n\t\t

The ValidityNotBefore value is expressed as an explicit date and time,\n\t\t\tusing the Validity type value ABSOLUTE. For more information,\n\t\t\tsee Validity in this API reference and Validity\n\t\t\tin RFC 5280.

" } }, "IdempotencyToken": { "target": "com.amazonaws.acmpca#IdempotencyToken", "traits": { - "smithy.api#documentation": "

Alphanumeric string that can be used to distinguish between calls to the IssueCertificate action. Idempotency tokens for IssueCertificate time out after one minute. Therefore, if you\n\t\t\tcall IssueCertificate multiple times with the same\n\t\t\tidempotency token within one minute, ACM Private CA recognizes that you are requesting only one\n\t\t\tcertificate and will issue only one. If you change the idempotency token for each call,\n\t\t\tPCA recognizes that you are requesting multiple certificates.

" + "smithy.api#documentation": "

Alphanumeric string that can be used to distinguish between calls to the IssueCertificate action. Idempotency tokens for IssueCertificate time out after one minute. Therefore, if you\n\t\t\tcall IssueCertificate multiple times with the same\n\t\t\tidempotency token within one minute, Amazon Web Services Private CA recognizes that you are requesting only\n\t\t\tone certificate and will issue only one. If you change the idempotency token for each\n\t\t\tcall, PCA recognizes that you are requesting multiple certificates.

" } } } @@ -2082,7 +2179,7 @@ } }, "traits": { - "smithy.api#documentation": "

An ACM Private CA quota has been exceeded. See the exception message returned to determine the\n\t\t\tquota that was exceeded.

", + "smithy.api#documentation": "

An Amazon Web Services Private CA quota has been exceeded. See the exception message returned to determine\n\t\t\tthe quota that was exceeded.

", "smithy.api#error": "client" } }, @@ -2175,7 +2272,7 @@ } ], "traits": { - "smithy.api#documentation": "

List all permissions on a private CA, if any, granted to the AWS Certificate Manager (ACM) service\n\t\t\tprincipal (acm.amazonaws.com).

\n\t\t

These permissions allow ACM to issue and renew ACM certificates that reside in the\n\t\t\tsame AWS account as the CA.

\n\t\t

Permissions can be granted with the CreatePermission action and\n\t\t\trevoked with the DeletePermission action.

\n\t\t

\n About Permissions\n

\n ", + "smithy.api#documentation": "

List all permissions on a private CA, if any, granted to the Certificate Manager (ACM) service\n\t\t\tprincipal (acm.amazonaws.com).

\n\t\t

These permissions allow ACM to issue and renew ACM certificates that reside in the\n\t\t\tsame Amazon Web Services account as the CA.

\n\t\t

Permissions can be granted with the CreatePermission action and\n\t\t\trevoked with the DeletePermission action.

\n\t\t

\n About Permissions\n

\n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -2364,12 +2461,12 @@ "OcspCustomCname": { "target": "com.amazonaws.acmpca#String253", "traits": { - "smithy.api#documentation": "

By default, ACM Private CA injects an AWS domain into certificates being validated by the\n\t\t\tOnline Certificate Status Protocol (OCSP). A customer can alternatively use this object\n\t\t\tto define a CNAME specifying a customized OCSP domain.

\n\t\t

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

\n\t\t

For more information, see Customizing Online Certificate \n\t\t\tStatus Protocol (OCSP) in the AWS Certificate Manager Private Certificate Authority (PCA) User\n\t\t\t\tGuide.

" + "smithy.api#documentation": "

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

\n\t\t

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

\n\t\t

For more information, see Customizing Online Certificate Status Protocol\n\t\t\t\t(OCSP) in the Amazon Web Services Private Certificate Authority User Guide.

" } } }, "traits": { - "smithy.api#documentation": "

Contains information to enable and configure Online Certificate Status Protocol (OCSP) for\n\t\t\tvalidating certificate revocation status.

\n\t\t

When you revoke a certificate, OCSP responses may take up to 60 minutes \n\tto reflect the new status.

" + "smithy.api#documentation": "

Contains information to enable and configure Online Certificate Status Protocol (OCSP)\n\t\t\tfor validating certificate revocation status.

\n\t\t

When you revoke a certificate, OCSP responses may take up to 60 minutes \n\tto reflect the new status.

" } }, "com.amazonaws.acmpca#OtherName": { @@ -2422,7 +2519,7 @@ "Principal": { "target": "com.amazonaws.acmpca#Principal", "traits": { - "smithy.api#documentation": "

The AWS service or entity that holds the permission. At this time, the only valid\n\t\t\tprincipal is acm.amazonaws.com.

" + "smithy.api#documentation": "

The Amazon Web Services service or entity that holds the permission. At this time, the only valid\n\t\t\tprincipal is acm.amazonaws.com.

" } }, "SourceAccount": { @@ -2434,7 +2531,7 @@ "Actions": { "target": "com.amazonaws.acmpca#ActionList", "traits": { - "smithy.api#documentation": "

The private CA actions that can be performed by the designated AWS service.

" + "smithy.api#documentation": "

The private CA actions that can be performed by the designated Amazon Web Services service.

" } }, "Policy": { @@ -2445,7 +2542,7 @@ } }, "traits": { - "smithy.api#documentation": "

Permissions designate which private CA actions can be performed by an AWS service or\n\t\t\tentity. In order for ACM to automatically renew private certificates, you must give\n\t\t\tthe ACM service principal all available permissions (IssueCertificate,\n\t\t\t\tGetCertificate, and ListPermissions). Permissions can be\n\t\t\tassigned with the CreatePermission action,\n\t\t\tremoved with the DeletePermission action, and\n\t\t\tlisted with the ListPermissions action.

" + "smithy.api#documentation": "

Permissions designate which private CA actions can be performed by an Amazon Web Services service or\n\t\t\tentity. In order for ACM to automatically renew private certificates, you must give\n\t\t\tthe ACM service principal all available permissions (IssueCertificate,\n\t\t\t\tGetCertificate, and ListPermissions). Permissions can be\n\t\t\tassigned with the CreatePermission action,\n\t\t\tremoved with the DeletePermission action, and\n\t\t\tlisted with the ListPermissions action.

" } }, "com.amazonaws.acmpca#PermissionAlreadyExistsException": { @@ -2484,7 +2581,7 @@ "PolicyQualifiers": { "target": "com.amazonaws.acmpca#PolicyQualifierInfoList", "traits": { - "smithy.api#documentation": "

Modifies the given CertPolicyId with a qualifier. ACM Private CA supports the\n\t\t\tcertification practice statement (CPS) qualifier.

" + "smithy.api#documentation": "

Modifies the given CertPolicyId with a qualifier. Amazon Web Services Private CA supports the\n\t\t\tcertification practice statement (CPS) qualifier.

" } } }, @@ -2516,13 +2613,13 @@ "Qualifier": { "target": "com.amazonaws.acmpca#Qualifier", "traits": { - "smithy.api#documentation": "

Defines the qualifier type. ACM Private CA supports the use of a URI for a CPS qualifier in\n\t\t\tthis field.

", + "smithy.api#documentation": "

Defines the qualifier type. Amazon Web Services Private CA supports the use of a URI for a CPS qualifier\n\t\t\tin this field.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Modifies the CertPolicyId of a PolicyInformation object with\n\t\t\ta qualifier. ACM Private CA supports the certification practice statement (CPS) qualifier.

" + "smithy.api#documentation": "

Modifies the CertPolicyId of a PolicyInformation object with\n\t\t\ta qualifier. Amazon Web Services Private CA supports the certification practice statement (CPS)\n\t\t\tqualifier.

" } }, "com.amazonaws.acmpca#PolicyQualifierInfoList": { @@ -2585,7 +2682,7 @@ } ], "traits": { - "smithy.api#documentation": "

Attaches a resource-based policy to a private CA.

\n\t\t

A policy can also be applied by sharing a private CA through AWS Resource Access\n\t\t\tManager (RAM). For more information, see Attach a Policy for Cross-Account\n\t\t\tAccess.

\n\t\t

The policy can be displayed with GetPolicy and removed with DeletePolicy.

\n

\n About Policies\n

\n " + "smithy.api#documentation": "

Attaches a resource-based policy to a private CA.

\n\t\t

A policy can also be applied by sharing a private CA through Amazon Web Services Resource Access\n\t\t\tManager (RAM). For more information, see Attach a Policy for Cross-Account\n\t\t\tAccess.

\n\t\t

The policy can be displayed with GetPolicy and removed with DeletePolicy.

\n\t\t

\n About Policies\n

\n " } }, "com.amazonaws.acmpca#PutPolicyRequest": { @@ -2619,7 +2716,7 @@ } }, "traits": { - "smithy.api#documentation": "

Defines a PolicyInformation qualifier. ACM Private CA supports the certification practice\n\t\t\t\tstatement (CPS) qualifier defined in RFC 5280.

" + "smithy.api#documentation": "

Defines a PolicyInformation qualifier. Amazon Web Services Private CA supports the certification\n\t\t\t\tpractice statement (CPS) qualifier defined in RFC 5280.

" } }, "com.amazonaws.acmpca#RequestAlreadyProcessedException": { @@ -2723,18 +2820,18 @@ "CrlConfiguration": { "target": "com.amazonaws.acmpca#CrlConfiguration", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

Configuration of the certificate revocation list (CRL), if any, maintained by your\n\t\t\tprivate CA. A CRL is typically updated approximately 30 minutes after a certificate \n\tis revoked. If for any reason a CRL update fails, Amazon Web Services Private CA makes further attempts \n\tevery 15 minutes.

" } }, "OcspConfiguration": { "target": "com.amazonaws.acmpca#OcspConfiguration", "traits": { - "smithy.api#documentation": "

Configuration of Online Certificate Status Protocol (OCSP) support, if any, maintained by\n\t\t\tyour private CA. When you revoke a certificate, OCSP responses may take up to 60 minutes \n\tto reflect the new status.

" + "smithy.api#documentation": "

Configuration of Online Certificate Status Protocol (OCSP) support, if any, maintained\n\t\t\tby your private CA. When you revoke a certificate, OCSP responses may take up to 60 minutes \n\tto reflect the new status.

" } } }, "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

Certificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority actions. Your private certificate authority (CA)\n\t\t\tcan configure Online Certificate Status Protocol (OCSP) support and/or maintain a\n\t\t\tcertificate revocation list (CRL). OCSP returns validation information about\n\t\t\tcertificates as requested by clients, and a CRL contains an updated list of certificates\n\t\t\trevoked by your CA. For more information, see RevokeCertificate and Setting up a\n\t\t\t\tcertificate revocation method in the Amazon Web Services Private Certificate Authority User\n\t\t\t\tGuide.

" } }, "com.amazonaws.acmpca#RevocationReason": { @@ -2811,7 +2908,7 @@ } ], "traits": { - "smithy.api#documentation": "

Revokes a certificate that was issued inside ACM Private CA. If you enable a certificate\n\t\t\trevocation list (CRL) when you create or update your private CA, information about the\n\t\t\trevoked certificates will be included in the CRL. ACM Private CA writes the CRL to an S3 bucket\n\t\t\tthat you specify. A CRL is typically updated approximately 30 minutes after a\n\t\t\tcertificate is revoked. If for any reason the CRL update fails, ACM Private CA attempts makes\n\t\t\tfurther attempts every 15 minutes. With Amazon CloudWatch, you can create alarms for the\n\t\t\tmetrics CRLGenerated and MisconfiguredCRLBucket. For more\n\t\t\tinformation, see Supported CloudWatch Metrics.

\n \n

Both PCA and the IAM principal must have permission to write to\n the S3 bucket that you specify. If the IAM principal making the call\n does not have permission to write to the bucket, then an exception is\n thrown. For more information, see Configure\n Access to ACM Private CA.

\n \n

ACM Private CA also writes\n\t\t\trevocation information to the audit report. For more information, see CreateCertificateAuthorityAuditReport.

\n\t\t \n\t\t\t

You cannot revoke a root CA self-signed certificate.

\n\t\t " + "smithy.api#documentation": "

Revokes a certificate that was issued inside Amazon Web Services Private CA. If you enable a certificate\n\t\t\trevocation list (CRL) when you create or update your private CA, information about the\n\t\t\trevoked certificates will be included in the CRL. Amazon Web Services Private CA writes the CRL to an S3\n\t\t\tbucket that you specify. A CRL is typically updated approximately 30 minutes after a\n\t\t\tcertificate is revoked. If for any reason the CRL update fails, Amazon Web Services Private CA attempts\n\t\t\tmakes further attempts every 15 minutes. With Amazon CloudWatch, you can create alarms\n\t\t\tfor the metrics CRLGenerated and MisconfiguredCRLBucket. For\n\t\t\tmore information, see Supported CloudWatch Metrics.

\n\t\t \n

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

\n \n\t\t

Amazon Web Services Private CA also writes revocation information to the audit report. For more\n\t\t\tinformation, see CreateCertificateAuthorityAuditReport.

\n\t\t \n\t\t\t

You cannot revoke a root CA self-signed certificate.

\n\t\t " } }, "com.amazonaws.acmpca#RevokeCertificateRequest": { @@ -2827,7 +2924,7 @@ "CertificateSerial": { "target": "com.amazonaws.acmpca#String128", "traits": { - "smithy.api#documentation": "

Serial number of the certificate to be revoked. This must be in hexadecimal format.\n\t\t\tYou can retrieve the serial number by calling GetCertificate with the Amazon\n\t\t\tResource Name (ARN) of the certificate you want and the ARN of your private CA. The\n\t\t\t\tGetCertificate action retrieves the certificate in\n\t\t\tthe PEM format. You can use the following OpenSSL command to list the certificate in\n\t\t\ttext format and copy the hexadecimal serial number.

\n\t\t

\n openssl x509 -in file_path -text -noout\n

\n\t\t

You can also copy the serial number from the console or use the DescribeCertificate action in the AWS Certificate Manager API\n\t\t\t\tReference.

", + "smithy.api#documentation": "

Serial number of the certificate to be revoked. This must be in hexadecimal format.\n\t\t\tYou can retrieve the serial number by calling GetCertificate with the Amazon\n\t\t\tResource Name (ARN) of the certificate you want and the ARN of your private CA. The\n\t\t\t\tGetCertificate action retrieves the certificate in\n\t\t\tthe PEM format. You can use the following OpenSSL command to list the certificate in\n\t\t\ttext format and copy the hexadecimal serial number.

\n\t\t

\n openssl x509 -in file_path -text -noout\n

\n\t\t

You can also copy the serial number from the console or use the DescribeCertificate action in the Certificate Manager API\n\t\t\t\tReference.

", "smithy.api#required": {} } }, @@ -2925,6 +3022,15 @@ } } }, + "com.amazonaws.acmpca#String1To256": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, "com.amazonaws.acmpca#String253": { "type": "string", "traits": { @@ -3044,7 +3150,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds one or more tags to your private CA. Tags are labels that you can use to identify\n\t\t\tand organize your AWS resources. Each tag consists of a key and an optional value. You\n\t\t\tspecify the private CA on input by its Amazon Resource Name (ARN). You specify the tag\n\t\t\tby using a key-value pair. You can apply a tag to just one private CA if you want to\n\t\t\tidentify a specific characteristic of that CA, or you can apply the same tag to multiple\n\t\t\tprivate CAs if you want to filter for a common relationship among those CAs. To remove\n\t\t\tone or more tags, use the UntagCertificateAuthority action. Call the ListTags action to see what tags are\n\t\t\tassociated with your CA.

" + "smithy.api#documentation": "

Adds one or more tags to your private CA. Tags are labels that you can use to identify\n\t\t\tand organize your Amazon Web Services resources. Each tag consists of a key and an optional value. You\n\t\t\tspecify the private CA on input by its Amazon Resource Name (ARN). You specify the tag\n\t\t\tby using a key-value pair. You can apply a tag to just one private CA if you want to\n\t\t\tidentify a specific characteristic of that CA, or you can apply the same tag to multiple\n\t\t\tprivate CAs if you want to filter for a common relationship among those CAs. To remove\n\t\t\tone or more tags, use the UntagCertificateAuthority action. Call the ListTags action to see what tags are\n\t\t\tassociated with your CA.

" } }, "com.amazonaws.acmpca#TagCertificateAuthorityRequest": { @@ -3178,7 +3284,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the status or configuration of a private certificate authority (CA). Your\n\t\t\tprivate CA must be in the ACTIVE or DISABLED state before you\n\t\t\tcan update it. You can disable a private CA that is in the ACTIVE state or\n\t\t\tmake a CA that is in the DISABLED state active again.

\n \n

Both PCA and the IAM principal must have permission to write to\n the S3 bucket that you specify. If the IAM principal making the call\n does not have permission to write to the bucket, then an exception is\n thrown. For more information, see Configure\n Access to ACM Private CA.

\n " + "smithy.api#documentation": "

Updates the status or configuration of a private certificate authority (CA). Your\n\t\t\tprivate CA must be in the ACTIVE or DISABLED state before you\n\t\t\tcan update it. You can disable a private CA that is in the ACTIVE state or\n\t\t\tmake a CA that is in the DISABLED state active again.

\n\t\t \n

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

\n " } }, "com.amazonaws.acmpca#UpdateCertificateAuthorityRequest": { @@ -3194,7 +3300,7 @@ "RevocationConfiguration": { "target": "com.amazonaws.acmpca#RevocationConfiguration", "traits": { - "smithy.api#documentation": "

Contains information to enable Online Certificate Status Protocol (OCSP) support, \n\t\t\tto enable a certificate revocation list (CRL), to enable both, or to enable neither. If\n\t\t\tthis parameter is not supplied, existing capibilites remain unchanged. For more\n\t\t\tinformation, see the OcspConfiguration and CrlConfiguration types.

" + "smithy.api#documentation": "

Contains information to enable Online Certificate Status Protocol (OCSP) support, to\n\t\t\tenable a certificate revocation list (CRL), to enable both, or to enable neither. If\n\t\t\tthis parameter is not supplied, existing capibilites remain unchanged. For more\n\t\t\tinformation, see the OcspConfiguration and CrlConfiguration types.

" } }, "Status": { @@ -3219,13 +3325,13 @@ "Type": { "target": "com.amazonaws.acmpca#ValidityPeriodType", "traits": { - "smithy.api#documentation": "

Determines how ACM Private CA interprets the Value\n\t\t\tparameter, an integer. Supported validity types include those listed below. Type\n\t\t\tdefinitions with values include a sample input value and the resulting output.

\n\t\t

\n END_DATE: The specific date and time when the certificate will expire,\n\t\t\texpressed using UTCTime (YYMMDDHHMMSS) or GeneralizedTime (YYYYMMDDHHMMSS) format. When\n\t\t\tUTCTime is used, if the year field (YY) is greater than or equal to 50, the year is\n\t\t\tinterpreted as 19YY. If the year field is less than 50, the year is interpreted as\n\t\t\t20YY.

\n\t\t \n\t\t

\n ABSOLUTE: The specific date and time when the validity of a certificate\n\t\t\twill start or expire, expressed in seconds since the Unix Epoch.

\n\t\t \n\t\t

\n DAYS, MONTHS, YEARS: The relative time from the\n\t\t\tmoment of issuance until the certificate will expire, expressed in days, months, or\n\t\t\tyears.

\n\t\t

Example if DAYS, issued on 10/12/2020 at 12:34:54 UTC:

\n\t\t \n\t\t

The minimum validity duration for a certificate using relative time\n\t\t\t(DAYS) is one day. The minimum validity for a certificate using absolute\n\t\t\ttime (ABSOLUTE or END_DATE) is one second.

", + "smithy.api#documentation": "

Determines how Amazon Web Services Private CA interprets the Value\n\t\t\tparameter, an integer. Supported validity types include those listed below. Type\n\t\t\tdefinitions with values include a sample input value and the resulting output.

\n\t\t

\n END_DATE: The specific date and time when the certificate will expire,\n\t\t\texpressed using UTCTime (YYMMDDHHMMSS) or GeneralizedTime (YYYYMMDDHHMMSS) format. When\n\t\t\tUTCTime is used, if the year field (YY) is greater than or equal to 50, the year is\n\t\t\tinterpreted as 19YY. If the year field is less than 50, the year is interpreted as\n\t\t\t20YY.

\n\t\t \n\t\t

\n ABSOLUTE: The specific date and time when the validity of a certificate\n\t\t\twill start or expire, expressed in seconds since the Unix Epoch.

\n\t\t \n\t\t

\n DAYS, MONTHS, YEARS: The relative time from the\n\t\t\tmoment of issuance until the certificate will expire, expressed in days, months, or\n\t\t\tyears.

\n\t\t

Example if DAYS, issued on 10/12/2020 at 12:34:54 UTC:

\n\t\t \n\t\t

The minimum validity duration for a certificate using relative time\n\t\t\t(DAYS) is one day. The minimum validity for a certificate using absolute\n\t\t\ttime (ABSOLUTE or END_DATE) is one second.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

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

\n\t\t

ACM Private CA API consumes the Validity data type differently in two distinct\n\t\t\tparameters of the IssueCertificate action. The required parameter\n\t\t\t\tIssueCertificate:Validity specifies the end of a\n\t\t\tcertificate's validity period. The optional parameter\n\t\t\t\tIssueCertificate:ValidityNotBefore specifies a customized\n\t\t\tstarting time for the validity period.

" + "smithy.api#documentation": "

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

\n\t\t

Amazon Web Services Private CA API consumes the Validity data type differently in two\n\t\t\tdistinct parameters of the IssueCertificate action. The required parameter\n\t\t\t\tIssueCertificate:Validity specifies the end of a\n\t\t\tcertificate's validity period. The optional parameter\n\t\t\t\tIssueCertificate:ValidityNotBefore specifies a customized\n\t\t\tstarting time for the validity period.

" } }, "com.amazonaws.acmpca#ValidityPeriodType": { diff --git a/codegen/sdk-codegen/aws-models/amplifybackend.json b/codegen/sdk-codegen/aws-models/amplifybackend.json index 16803c19a6e7f..ff308f4a21366 100644 --- a/codegen/sdk-codegen/aws-models/amplifybackend.json +++ b/codegen/sdk-codegen/aws-models/amplifybackend.json @@ -811,7 +811,7 @@ "DeliveryMethod": { "target": "com.amazonaws.amplifybackend#DeliveryMethod", "traits": { - "smithy.api#documentation": "

Describes which mode to use (either SMS or email) to deliver messages to app users who want to recover their password.

", + "smithy.api#documentation": "

(DEPRECATED) Describes which mode to use (either SMS or email) to deliver messages to app users who want to recover their password.

", "smithy.api#jsonName": "deliveryMethod", "smithy.api#required": {} } @@ -819,20 +819,20 @@ "EmailSettings": { "target": "com.amazonaws.amplifybackend#EmailSettings", "traits": { - "smithy.api#documentation": "

The configuration for the email sent when an app user forgets their password.

", + "smithy.api#documentation": "

(DEPRECATED) The configuration for the email sent when an app user forgets their password.

", "smithy.api#jsonName": "emailSettings" } }, "SmsSettings": { "target": "com.amazonaws.amplifybackend#SmsSettings", "traits": { - "smithy.api#documentation": "

The configuration for the SMS message sent when an app user forgets their password.

", + "smithy.api#documentation": "

(DEPRECATED) The configuration for the SMS message sent when an app user forgets their password.

", "smithy.api#jsonName": "smsSettings" } } }, "traits": { - "smithy.api#documentation": "

Describes the forgot password policy for authenticating into the Amplify app.

" + "smithy.api#documentation": "

(DEPRECATED) Describes the forgot password policy for authenticating into the Amplify app.

" } }, "com.amazonaws.amplifybackend#CreateBackendAuthIdentityPoolConfig": { @@ -1090,7 +1090,7 @@ "ForgotPassword": { "target": "com.amazonaws.amplifybackend#CreateBackendAuthForgotPasswordConfig", "traits": { - "smithy.api#documentation": "

Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.

", + "smithy.api#documentation": "

(DEPRECATED) Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.

", "smithy.api#jsonName": "forgotPassword" } }, @@ -1138,12 +1138,49 @@ "smithy.api#jsonName": "userPoolName", "smithy.api#required": {} } + }, + "VerificationMessage": { + "target": "com.amazonaws.amplifybackend#CreateBackendAuthVerificationMessageConfig", + "traits": { + "smithy.api#documentation": "

Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.

", + "smithy.api#jsonName": "verificationMessage" + } } }, "traits": { "smithy.api#documentation": "

Describes the Amazon Cognito user pool configuration for the auth resource to be configured for your Amplify project.

" } }, + "com.amazonaws.amplifybackend#CreateBackendAuthVerificationMessageConfig": { + "type": "structure", + "members": { + "DeliveryMethod": { + "target": "com.amazonaws.amplifybackend#DeliveryMethod", + "traits": { + "smithy.api#documentation": "

The type of verification message to send.

", + "smithy.api#jsonName": "deliveryMethod", + "smithy.api#required": {} + } + }, + "EmailSettings": { + "target": "com.amazonaws.amplifybackend#EmailSettings", + "traits": { + "smithy.api#documentation": "

The settings for the email message.

", + "smithy.api#jsonName": "emailSettings" + } + }, + "SmsSettings": { + "target": "com.amazonaws.amplifybackend#SmsSettings", + "traits": { + "smithy.api#documentation": "

The settings for the SMS message.

", + "smithy.api#jsonName": "smsSettings" + } + } + }, + "traits": { + "smithy.api#documentation": "

Creates an email or SMS verification message for the auth resource configured for your Amplify project.

" + } + }, "com.amazonaws.amplifybackend#CreateBackendConfig": { "type": "operation", "input": { @@ -1261,7 +1298,7 @@ "ResourceConfig": { "target": "com.amazonaws.amplifybackend#ResourceConfig", "traits": { - "smithy.api#documentation": "

The resource configuration for creating backend storage.

", + "smithy.api#documentation": "

The resource configuration for creating a backend.

", "smithy.api#jsonName": "resourceConfig" } }, @@ -2033,6 +2070,7 @@ "com.amazonaws.amplifybackend#DeliveryMethod": { "type": "string", "traits": { + "smithy.api#documentation": "

The type of verification message to send.

", "smithy.api#enum": [ { "value": "EMAIL", @@ -2051,14 +2089,14 @@ "EmailMessage": { "target": "com.amazonaws.amplifybackend#__string", "traits": { - "smithy.api#documentation": "

The body of the email.

", + "smithy.api#documentation": "

The contents of the email message.

", "smithy.api#jsonName": "emailMessage" } }, "EmailSubject": { "target": "com.amazonaws.amplifybackend#__string", "traits": { - "smithy.api#documentation": "

The subject of the email.

", + "smithy.api#documentation": "

The contents of the subject line of the email message.

", "smithy.api#jsonName": "emailSubject" } } @@ -3916,7 +3954,7 @@ "SmsMessage": { "target": "com.amazonaws.amplifybackend#__string", "traits": { - "smithy.api#documentation": "

The body of the SMS message.

", + "smithy.api#documentation": "

The contents of the SMS message.

", "smithy.api#jsonName": "smsMessage" } } @@ -4157,27 +4195,27 @@ "DeliveryMethod": { "target": "com.amazonaws.amplifybackend#DeliveryMethod", "traits": { - "smithy.api#documentation": "

Describes which mode to use (either SMS or email) to deliver messages to app users that want to recover their password.

", + "smithy.api#documentation": "

(DEPRECATED) Describes which mode to use (either SMS or email) to deliver messages to app users that want to recover their password.

", "smithy.api#jsonName": "deliveryMethod" } }, "EmailSettings": { "target": "com.amazonaws.amplifybackend#EmailSettings", "traits": { - "smithy.api#documentation": "

The configuration for the email sent when an app user forgets their password.

", + "smithy.api#documentation": "

(DEPRECATED) The configuration for the email sent when an app user forgets their password.

", "smithy.api#jsonName": "emailSettings" } }, "SmsSettings": { "target": "com.amazonaws.amplifybackend#SmsSettings", "traits": { - "smithy.api#documentation": "

The configuration for the SMS message sent when an Amplify app user forgets their password.

", + "smithy.api#documentation": "

(DEPRECATED) The configuration for the SMS message sent when an Amplify app user forgets their password.

", "smithy.api#jsonName": "smsSettings" } } }, "traits": { - "smithy.api#documentation": "

Describes the forgot password policy for authenticating into the Amplify app.

" + "smithy.api#documentation": "

(DEPRECATED) Describes the forgot password policy for authenticating into the Amplify app.

" } }, "com.amazonaws.amplifybackend#UpdateBackendAuthIdentityPoolConfig": { @@ -4420,7 +4458,7 @@ "ForgotPassword": { "target": "com.amazonaws.amplifybackend#UpdateBackendAuthForgotPasswordConfig", "traits": { - "smithy.api#documentation": "

Describes the forgot password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.

", + "smithy.api#documentation": "

(DEPRECATED) Describes the forgot password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.

", "smithy.api#jsonName": "forgotPassword" } }, @@ -4444,12 +4482,49 @@ "smithy.api#documentation": "

Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.

", "smithy.api#jsonName": "passwordPolicy" } + }, + "VerificationMessage": { + "target": "com.amazonaws.amplifybackend#UpdateBackendAuthVerificationMessageConfig", + "traits": { + "smithy.api#documentation": "

Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.

", + "smithy.api#jsonName": "verificationMessage" + } } }, "traits": { "smithy.api#documentation": "

Describes the Amazon Cognito user pool configuration for the authorization resource to be configured for your Amplify project on an update.

" } }, + "com.amazonaws.amplifybackend#UpdateBackendAuthVerificationMessageConfig": { + "type": "structure", + "members": { + "DeliveryMethod": { + "target": "com.amazonaws.amplifybackend#DeliveryMethod", + "traits": { + "smithy.api#documentation": "

The type of verification message to send.

", + "smithy.api#jsonName": "deliveryMethod", + "smithy.api#required": {} + } + }, + "EmailSettings": { + "target": "com.amazonaws.amplifybackend#EmailSettings", + "traits": { + "smithy.api#documentation": "

The settings for the email message.

", + "smithy.api#jsonName": "emailSettings" + } + }, + "SmsSettings": { + "target": "com.amazonaws.amplifybackend#SmsSettings", + "traits": { + "smithy.api#documentation": "

The settings for the SMS message.

", + "smithy.api#jsonName": "smsSettings" + } + } + }, + "traits": { + "smithy.api#documentation": "

Updates the configuration of the email or SMS message for the auth resource configured for your Amplify project.

" + } + }, "com.amazonaws.amplifybackend#UpdateBackendConfig": { "type": "operation", "input": { diff --git a/codegen/sdk-codegen/aws-models/billingconductor.json b/codegen/sdk-codegen/aws-models/billingconductor.json new file mode 100644 index 0000000000000..8b2ab81e6efcf --- /dev/null +++ b/codegen/sdk-codegen/aws-models/billingconductor.json @@ -0,0 +1,4677 @@ +{ + "smithy": "1.0", + "shapes": { + "com.amazonaws.billingconductor#AWSBillingConductor": { + "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "billingconductor", + "arnNamespace": "billingconductor" + }, + "aws.auth#sigv4": { + "name": "billingconductor" + }, + "aws.iam#defineConditionKeys": { + "aws:ResourceTag/${TagKey}": { + "type": "String", + "documentation": "Filters access based on the tags associated with the resource", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-resourcetag" + }, + "aws:RequestTag/${TagKey}": { + "type": "String", + "documentation": "Filters access based on the tags that are passed in the request", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-requesttag" + }, + "aws:TagKeys": { + "type": "String", + "documentation": "Filters access based on the tag keys that are passed in the request", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-tagkeys" + } + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": ["X-Api-Key"] + }, + "smithy.api#documentation": "

Amazon Web Services Billing Conductor is a fully managed service that you can use\n to customize a pro forma version of your billing data each month, to accurately show or chargeback\n your end customers. Amazon Web Services Billing Conductor doesn't change the way\n you're billed by Amazon Web Services each month by design. Instead, it provides you with a\n mechanism to configure, generate, and display rates to certain customers over a given billing\n period. You can also analyze the difference between the rates you apply to your accounting\n groupings relative to your actual rates from Amazon Web Services. As a result of your Amazon Web Services Billing Conductor configuration, the payer account can also see the\n custom rate applied on the billing details page of the Amazon Web Services Billing console, or configure a cost and usage report per\n billing group.

\n

This documentation shows how you can configure Amazon Web Services Billing Conductor using its\n API. For more information about using the Amazon Web Services\n Billing Conductor user interface, see the Amazon Web Services Enterprise\n Billing Console User Guide.

", + "smithy.api#title": "AWSBillingConductor" + }, + "version": "2021-07-30", + "operations": [ + { + "target": "com.amazonaws.billingconductor#ListAccountAssociations" + }, + { + "target": "com.amazonaws.billingconductor#ListBillingGroupCostReports" + }, + { + "target": "com.amazonaws.billingconductor#ListTagsForResource" + }, + { + "target": "com.amazonaws.billingconductor#TagResource" + }, + { + "target": "com.amazonaws.billingconductor#UntagResource" + } + ], + "resources": [ + { + "target": "com.amazonaws.billingconductor#BillingGroup" + }, + { + "target": "com.amazonaws.billingconductor#CustomLineItem" + }, + { + "target": "com.amazonaws.billingconductor#PricingPlan" + }, + { + "target": "com.amazonaws.billingconductor#PricingRule" + } + ] + }, + "com.amazonaws.billingconductor#AWSCost": { + "type": "string" + }, + "com.amazonaws.billingconductor#AccessDeniedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.billingconductor#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

You do not have sufficient access to perform this action.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.billingconductor#AccountAssociationsList": { + "type": "list", + "member": { + "target": "com.amazonaws.billingconductor#AccountAssociationsListElement" + } + }, + "com.amazonaws.billingconductor#AccountAssociationsListElement": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.billingconductor#AccountId", + "traits": { + "smithy.api#documentation": "

\n The associating array of account IDs.\n

" + } + }, + "BillingGroupArn": { + "target": "com.amazonaws.billingconductor#BillingGroupArn", + "traits": { + "smithy.api#documentation": "

The Billing Group Arn that the linked account is associated to.

" + } + }, + "AccountName": { + "target": "com.amazonaws.billingconductor#AccountName", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Services account name.\n

" + } + }, + "AccountEmail": { + "target": "com.amazonaws.billingconductor#AccountEmail", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Services account email. \n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n \n Amazon Web Services Billing Conductor is in beta release and is subject to change. Your use of Amazon Web Services Billing Conductor is subject to the Beta Service Participation terms of the Amazon Web Services Service Terms (Section 1.10).\n \n

\n

A representation of a linked account.

" + } + }, + "com.amazonaws.billingconductor#AccountEmail": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.billingconductor#AccountGrouping": { + "type": "structure", + "members": { + "LinkedAccountIds": { + "target": "com.amazonaws.billingconductor#AccountIdList", + "traits": { + "smithy.api#documentation": "

\n The account IDs that make up the billing group. Account IDs must be a part of the consolidated billing family, and not associated with another billing group.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The set of accounts that will be under the billing group. The set of accounts resemble the linked accounts in a consolidated family.\n

" + } + }, + "com.amazonaws.billingconductor#AccountId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9]{12}$" + } + }, + "com.amazonaws.billingconductor#AccountIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.billingconductor#AccountId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30 + } + } + }, + "com.amazonaws.billingconductor#AccountName": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.billingconductor#Arn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + }, + "smithy.api#pattern": "^arn:aws(-cn)?:billingconductor::[0-9]{12}:billinggroup/?[0-9]{12}$|^arn:aws(-cn)?:billingconductor::[0-9]{12}:pricingplan/[a-zA-Z0-9]{10}$|^arn:aws(-cn)?:billingconductor::[0-9]{12}:pricingrule/[a-zA-Z0-9]{10}$|^(arn:aws(-cn)?:billingconductor::[0-9]{12}:customlineitem/)?[a-zA-Z0-9]{10}$" + } + }, + "com.amazonaws.billingconductor#AssociateAccounts": { + "type": "operation", + "input": { + "target": "com.amazonaws.billingconductor#AssociateAccountsInput" + }, + "output": { + "target": "com.amazonaws.billingconductor#AssociateAccountsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.billingconductor#AccessDeniedException" + }, + { + "target": "com.amazonaws.billingconductor#ConflictException" + }, + { + "target": "com.amazonaws.billingconductor#InternalServerException" + }, + { + "target": "com.amazonaws.billingconductor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.billingconductor#ServiceLimitExceededException" + }, + { + "target": "com.amazonaws.billingconductor#ThrottlingException" + }, + { + "target": "com.amazonaws.billingconductor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Connects an array of account IDs in a consolidated billing family to a predefined\n billing group. The account IDs must be a part of the consolidated billing family during the\n current month, and not already associated with another billing group. The maximum number of\n accounts that can be associated in one call is 30.

", + "smithy.api#http": { + "method": "POST", + "uri": "/associate-accounts", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.billingconductor#AssociateAccountsInput": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.billingconductor#BillingGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the billing group that associates the array of\n account IDs.

", + "smithy.api#required": {} + } + }, + "AccountIds": { + "target": "com.amazonaws.billingconductor#AccountIdList", + "traits": { + "smithy.api#documentation": "

\n The associating array of account IDs.\n

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.billingconductor#AssociateAccountsOutput": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.billingconductor#BillingGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the billing group that associates the array of\n account IDs.

" + } + } + } + }, + "com.amazonaws.billingconductor#AssociatePricingRules": { + "type": "operation", + "input": { + "target": "com.amazonaws.billingconductor#AssociatePricingRulesInput" + }, + "output": { + "target": "com.amazonaws.billingconductor#AssociatePricingRulesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.billingconductor#AccessDeniedException" + }, + { + "target": "com.amazonaws.billingconductor#ConflictException" + }, + { + "target": "com.amazonaws.billingconductor#InternalServerException" + }, + { + "target": "com.amazonaws.billingconductor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.billingconductor#ServiceLimitExceededException" + }, + { + "target": "com.amazonaws.billingconductor#ThrottlingException" + }, + { + "target": "com.amazonaws.billingconductor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Connects an array of PricingRuleArns to a defined PricingPlan.\n The maximum number PricingRuleArn that can be associated in one call is 30.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/associate-pricing-rules", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.billingconductor#AssociatePricingRulesInput": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.billingconductor#PricingPlanArn", + "traits": { + "smithy.api#documentation": "

\n The PricingPlanArn that the PricingRuleArns are associated with.\n

", + "smithy.api#required": {} + } + }, + "PricingRuleArns": { + "target": "com.amazonaws.billingconductor#PricingRuleArnsNonEmptyInput", + "traits": { + "smithy.api#documentation": "

\n The PricingRuleArns that are associated with the Pricing Plan.\n

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.billingconductor#AssociatePricingRulesOutput": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.billingconductor#PricingPlanArn", + "traits": { + "smithy.api#documentation": "

\n The PricingPlanArn that the PricingRuleArns are associated with.\n

" + } + } + } + }, + "com.amazonaws.billingconductor#AssociateResourceError": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.billingconductor#String", + "traits": { + "smithy.api#documentation": "

\n The reason the resource association failed.\n

" + } + }, + "Reason": { + "target": "com.amazonaws.billingconductor#AssociateResourceErrorReason", + "traits": { + "smithy.api#documentation": "

\n A static error code that used to classify the type of failure.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n A representation of a resource association error.\n

" + } + }, + "com.amazonaws.billingconductor#AssociateResourceErrorReason": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "INVALID_ARN", + "name": "INVALID_ARN" + }, + { + "value": "SERVICE_LIMIT_EXCEEDED", + "name": "SERVICE_LIMIT_EXCEEDED" + }, + { + "value": "ILLEGAL_CUSTOMLINEITEM", + "name": "ILLEGAL_CUSTOMLINEITEM" + }, + { + "value": "INTERNAL_SERVER_EXCEPTION", + "name": "INTERNAL_SERVER_EXCEPTION" + } + ] + } + }, + "com.amazonaws.billingconductor#AssociateResourceResponseElement": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.billingconductor#CustomLineItemArn", + "traits": { + "smithy.api#documentation": "

\n The resource ARN that was associated to the custom line item.\n

" + } + }, + "Error": { + "target": "com.amazonaws.billingconductor#AssociateResourceError", + "traits": { + "smithy.api#documentation": "

\n An AssociateResourceError that will populate if the resource association fails.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n A resource association result for a percentage custom line item.\n

" + } + }, + "com.amazonaws.billingconductor#AssociateResourcesResponseList": { + "type": "list", + "member": { + "target": "com.amazonaws.billingconductor#AssociateResourceResponseElement" + } + }, + "com.amazonaws.billingconductor#Association": { + "type": "string", + "traits": { + "smithy.api#pattern": "^((arn:aws:billingconductor::[0-9]{12}:billinggroup/)?[0-9]{12}|MONITORED|UNMONITORED)$" + } + }, + "com.amazonaws.billingconductor#BatchAssociateResourcesToCustomLineItem": { + "type": "operation", + "input": { + "target": "com.amazonaws.billingconductor#BatchAssociateResourcesToCustomLineItemInput" + }, + "output": { + "target": "com.amazonaws.billingconductor#BatchAssociateResourcesToCustomLineItemOutput" + }, + "errors": [ + { + "target": "com.amazonaws.billingconductor#AccessDeniedException" + }, + { + "target": "com.amazonaws.billingconductor#ConflictException" + }, + { + "target": "com.amazonaws.billingconductor#InternalServerException" + }, + { + "target": "com.amazonaws.billingconductor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.billingconductor#ServiceLimitExceededException" + }, + { + "target": "com.amazonaws.billingconductor#ThrottlingException" + }, + { + "target": "com.amazonaws.billingconductor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Associates a batch of resources to a percentage custom line item.\n

", + "smithy.api#http": { + "method": "PUT", + "uri": "/batch-associate-resources-to-custom-line-item", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.billingconductor#BatchAssociateResourcesToCustomLineItemInput": { + "type": "structure", + "members": { + "TargetArn": { + "target": "com.amazonaws.billingconductor#CustomLineItemArn", + "traits": { + "smithy.api#documentation": "

\n A percentage custom line item ARN to associate the resources to.\n

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "Arn" + } + }, + "ResourceArns": { + "target": "com.amazonaws.billingconductor#CustomLineItemBatchAssociationsList", + "traits": { + "smithy.api#documentation": "

\n A list containing the ARNs of the resources to be associated.\n

", + "smithy.api#required": {} + } + }, + "BillingPeriodRange": { + "target": "com.amazonaws.billingconductor#CustomLineItemBillingPeriodRange" + } + } + }, + "com.amazonaws.billingconductor#BatchAssociateResourcesToCustomLineItemOutput": { + "type": "structure", + "members": { + "SuccessfullyAssociatedResources": { + "target": "com.amazonaws.billingconductor#AssociateResourcesResponseList", + "traits": { + "smithy.api#documentation": "

\n A list of AssociateResourceResponseElement for each resource that's been associated to a percentage custom line item successfully.\n

" + } + }, + "FailedAssociatedResources": { + "target": "com.amazonaws.billingconductor#AssociateResourcesResponseList", + "traits": { + "smithy.api#documentation": "

\n A list of AssociateResourceResponseElement for each resource that failed association to a percentage custom line item.\n

" + } + } + } + }, + "com.amazonaws.billingconductor#BatchDisassociateResourcesFromCustomLineItem": { + "type": "operation", + "input": { + "target": "com.amazonaws.billingconductor#BatchDisassociateResourcesFromCustomLineItemInput" + }, + "output": { + "target": "com.amazonaws.billingconductor#BatchDisassociateResourcesFromCustomLineItemOutput" + }, + "errors": [ + { + "target": "com.amazonaws.billingconductor#AccessDeniedException" + }, + { + "target": "com.amazonaws.billingconductor#ConflictException" + }, + { + "target": "com.amazonaws.billingconductor#InternalServerException" + }, + { + "target": "com.amazonaws.billingconductor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.billingconductor#ThrottlingException" + }, + { + "target": "com.amazonaws.billingconductor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Disassociates a batch of resources from a percentage custom line item.\n

", + "smithy.api#http": { + "method": "PUT", + "uri": "/batch-disassociate-resources-from-custom-line-item", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.billingconductor#BatchDisassociateResourcesFromCustomLineItemInput": { + "type": "structure", + "members": { + "TargetArn": { + "target": "com.amazonaws.billingconductor#CustomLineItemArn", + "traits": { + "smithy.api#documentation": "

\n A percentage custom line item ARN to disassociate the resources from.\n

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "Arn" + } + }, + "ResourceArns": { + "target": "com.amazonaws.billingconductor#CustomLineItemBatchDisassociationsList", + "traits": { + "smithy.api#documentation": "

\n A list containing the ARNs of resources to be disassociated.\n

", + "smithy.api#required": {} + } + }, + "BillingPeriodRange": { + "target": "com.amazonaws.billingconductor#CustomLineItemBillingPeriodRange" + } + } + }, + "com.amazonaws.billingconductor#BatchDisassociateResourcesFromCustomLineItemOutput": { + "type": "structure", + "members": { + "SuccessfullyDisassociatedResources": { + "target": "com.amazonaws.billingconductor#DisassociateResourcesResponseList", + "traits": { + "smithy.api#documentation": "

\n A list of DisassociateResourceResponseElement for each resource that's been disassociated from a percentage custom line item successfully.\n

" + } + }, + "FailedDisassociatedResources": { + "target": "com.amazonaws.billingconductor#DisassociateResourcesResponseList", + "traits": { + "smithy.api#documentation": "

\n A list of DisassociateResourceResponseElement for each resource that failed disassociation from a percentage custom line item.\n

" + } + } + } + }, + "com.amazonaws.billingconductor#BillingGroup": { + "type": "resource", + "identifiers": { + "Arn": { + "target": "com.amazonaws.billingconductor#BillingGroupArn" + } + }, + "create": { + "target": "com.amazonaws.billingconductor#CreateBillingGroup" + }, + "update": { + "target": "com.amazonaws.billingconductor#UpdateBillingGroup" + }, + "delete": { + "target": "com.amazonaws.billingconductor#DeleteBillingGroup" + }, + "list": { + "target": "com.amazonaws.billingconductor#ListBillingGroups" + }, + "operations": [ + { + "target": "com.amazonaws.billingconductor#AssociateAccounts" + }, + { + "target": "com.amazonaws.billingconductor#DisassociateAccounts" + } + ], + "traits": { + "aws.cloudformation#cfnResource": {}, + "aws.iam#conditionKeys": ["aws:ResourceTag/${TagKey}"], + "aws.iam#disableConditionKeyInference": {}, + "smithy.api#documentation": "A billing group is a set of linked account which belong to the same end customer.\nIt can be seen as a virtual consolidated billing family.\n" + } + }, + "com.amazonaws.billingconductor#BillingGroupArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(arn:aws:billingconductor::[0-9]{12}:billinggroup/)?[0-9]{12}$" + } + }, + "com.amazonaws.billingconductor#BillingGroupArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.billingconductor#BillingGroupArn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.billingconductor#BillingGroupCostReportElement": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.billingconductor#BillingGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a billing group.

" + } + }, + "AWSCost": { + "target": "com.amazonaws.billingconductor#AWSCost", + "traits": { + "smithy.api#documentation": "

The actual Amazon Web Services charges for the billing group.\n

" + } + }, + "ProformaCost": { + "target": "com.amazonaws.billingconductor#ProformaCost", + "traits": { + "smithy.api#documentation": "

The hypothetical Amazon Web Services charges based on the associated pricing plan of a billing group.\n

" + } + }, + "Margin": { + "target": "com.amazonaws.billingconductor#Margin", + "traits": { + "smithy.api#documentation": "

\n The billing group margin.\n

" + } + }, + "MarginPercentage": { + "target": "com.amazonaws.billingconductor#MarginPercentage", + "traits": { + "smithy.api#documentation": "

\n The percentage of billing group margin.\n

" + } + }, + "Currency": { + "target": "com.amazonaws.billingconductor#Currency", + "traits": { + "smithy.api#documentation": "

The displayed currency.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A summary report of actual Amazon Web Services charges and calculated Amazon Web Services charges, based on the associated pricing plan of a billing group.\n

" + } + }, + "com.amazonaws.billingconductor#BillingGroupCostReportList": { + "type": "list", + "member": { + "target": "com.amazonaws.billingconductor#BillingGroupCostReportElement" + } + }, + "com.amazonaws.billingconductor#BillingGroupDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.billingconductor#BillingGroupFullArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws:billingconductor::[0-9]{12}:billinggroup/[0-9]{12}$" + } + }, + "com.amazonaws.billingconductor#BillingGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.billingconductor#BillingGroupListElement" + } + }, + "com.amazonaws.billingconductor#BillingGroupListElement": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.billingconductor#BillingGroupName", + "traits": { + "smithy.api#documentation": "

The billing group's name.\n

" + } + }, + "Arn": { + "target": "com.amazonaws.billingconductor#BillingGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) that can be used to uniquely identify the billing group.\n

" + } + }, + "Description": { + "target": "com.amazonaws.billingconductor#BillingGroupDescription", + "traits": { + "smithy.api#documentation": "

The billing group description.\n

" + } + }, + "PrimaryAccountId": { + "target": "com.amazonaws.billingconductor#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID that serves as the main account in a billing group.

" + } + }, + "ComputationPreference": { + "target": "com.amazonaws.billingconductor#ComputationPreference" + }, + "Size": { + "target": "com.amazonaws.billingconductor#NumberOfAccounts", + "traits": { + "smithy.api#documentation": "

The number of accounts in the particular billing group.\n

" + } + }, + "CreationTime": { + "target": "com.amazonaws.billingconductor#Instant", + "traits": { + "smithy.api#documentation": "

\n The time the billing group was created.\n

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.billingconductor#Instant", + "traits": { + "smithy.api#documentation": "

\n The most recent time the billing group was modified.\n

" + } + }, + "Status": { + "target": "com.amazonaws.billingconductor#BillingGroupStatus", + "traits": { + "smithy.api#documentation": "

The billing group status. Only one of the valid values can be used.\n

" + } + }, + "StatusReason": { + "target": "com.amazonaws.billingconductor#BillingGroupStatusReason", + "traits": { + "smithy.api#documentation": "

The reason why the billing group is in its current status.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A representation of a billing group.\n

" + } + }, + "com.amazonaws.billingconductor#BillingGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_\\+=\\.\\-@]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.billingconductor#BillingGroupStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "PRIMARY_ACCOUNT_MISSING", + "name": "PRIMARY_ACCOUNT_MISSING" + } + ] + } + }, + "com.amazonaws.billingconductor#BillingGroupStatusReason": { + "type": "string" + }, + "com.amazonaws.billingconductor#BillingPeriod": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\d{4}-(0?[1-9]|1[012])$" + } + }, + "com.amazonaws.billingconductor#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.billingconductor#ComputationPreference": { + "type": "structure", + "members": { + "PricingPlanArn": { + "target": "com.amazonaws.billingconductor#PricingPlanFullArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the pricing plan used to compute the Amazon Web Services charges for a billing group.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The preferences and settings that will be used to compute the Amazon Web Services charges for a billing group.\n

" + } + }, + "com.amazonaws.billingconductor#ConflictException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.billingconductor#String", + "traits": { + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.billingconductor#String", + "traits": { + "smithy.api#documentation": "

Identifier of the resource in use.\n

", + "smithy.api#required": {} + } + }, + "ResourceType": { + "target": "com.amazonaws.billingconductor#String", + "traits": { + "smithy.api#documentation": "

Type of the resource in use.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

You can cause an inconsistent state by updating or deleting a resource.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.billingconductor#CreateBillingGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.billingconductor#CreateBillingGroupInput" + }, + "output": { + "target": "com.amazonaws.billingconductor#CreateBillingGroupOutput" + }, + "errors": [ + { + "target": "com.amazonaws.billingconductor#AccessDeniedException" + }, + { + "target": "com.amazonaws.billingconductor#ConflictException" + }, + { + "target": "com.amazonaws.billingconductor#InternalServerException" + }, + { + "target": "com.amazonaws.billingconductor#ServiceLimitExceededException" + }, + { + "target": "com.amazonaws.billingconductor#ThrottlingException" + }, + { + "target": "com.amazonaws.billingconductor#ValidationException" + } + ], + "traits": { + "aws.iam#conditionKeys": ["aws:TagKeys", "aws:RequestTag/${TagKey}"], + "smithy.api#documentation": "

\n Creates a billing group that resembles a consolidated billing family that Amazon Web Services charges, based off of the predefined pricing plan computation.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/create-billing-group", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.billingconductor#CreateBillingGroupInput": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.billingconductor#ClientToken", + "traits": { + "smithy.api#documentation": "

\n The token that is needed to support idempotency. Idempotency isn't currently supported, but will be implemented in a future update. \n

", + "smithy.api#httpHeader": "X-Amzn-Client-Token", + "smithy.api#idempotencyToken": {} + } + }, + "Name": { + "target": "com.amazonaws.billingconductor#BillingGroupName", + "traits": { + "smithy.api#documentation": "

\n The billing group name. The names must be unique.\n

", + "smithy.api#required": {} + } + }, + "AccountGrouping": { + "target": "com.amazonaws.billingconductor#AccountGrouping", + "traits": { + "smithy.api#documentation": "

\n The set of accounts that will be under the billing group. The set of accounts resemble the linked accounts in a consolidated family.\n

", + "smithy.api#required": {} + } + }, + "ComputationPreference": { + "target": "com.amazonaws.billingconductor#ComputationPreference", + "traits": { + "smithy.api#documentation": "

\n The preferences and settings that will be used to compute the Amazon Web Services charges for a billing group.\n

", + "smithy.api#required": {} + } + }, + "PrimaryAccountId": { + "target": "com.amazonaws.billingconductor#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID that serves as the main account in a billing group.

" + } + }, + "Description": { + "target": "com.amazonaws.billingconductor#BillingGroupDescription", + "traits": { + "smithy.api#documentation": "

The billing group description.\n

" + } + }, + "Tags": { + "target": "com.amazonaws.billingconductor#TagMap", + "traits": { + "smithy.api#documentation": "

A map that contains tag keys and tag values that are attached to a billing group. This\n feature isn't available during the beta.

" + } + } + } + }, + "com.amazonaws.billingconductor#CreateBillingGroupOutput": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.billingconductor#BillingGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the created billing group.

" + } + } + } + }, + "com.amazonaws.billingconductor#CreateCustomLineItem": { + "type": "operation", + "input": { + "target": "com.amazonaws.billingconductor#CreateCustomLineItemInput" + }, + "output": { + "target": "com.amazonaws.billingconductor#CreateCustomLineItemOutput" + }, + "errors": [ + { + "target": "com.amazonaws.billingconductor#AccessDeniedException" + }, + { + "target": "com.amazonaws.billingconductor#ConflictException" + }, + { + "target": "com.amazonaws.billingconductor#InternalServerException" + }, + { + "target": "com.amazonaws.billingconductor#ServiceLimitExceededException" + }, + { + "target": "com.amazonaws.billingconductor#ThrottlingException" + }, + { + "target": "com.amazonaws.billingconductor#ValidationException" + } + ], + "traits": { + "aws.iam#conditionKeys": ["aws:TagKeys", "aws:RequestTag/${TagKey}"], + "smithy.api#documentation": "

\n Creates a custom line item that can be used to create a one-time fixed charge that can be applied to a single billing group for the current or previous billing period. The one-time fixed charge is either a fee or discount. \n

", + "smithy.api#http": { + "method": "POST", + "uri": "/create-custom-line-item", + "code": 200 + } + } + }, + "com.amazonaws.billingconductor#CreateCustomLineItemInput": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.billingconductor#ClientToken", + "traits": { + "smithy.api#documentation": "

\n The token that is needed to support idempotency. Idempotency isn't currently supported, but will be implemented in a future update. \n

", + "smithy.api#httpHeader": "X-Amzn-Client-Token", + "smithy.api#idempotencyToken": {} + } + }, + "Name": { + "target": "com.amazonaws.billingconductor#CustomLineItemName", + "traits": { + "smithy.api#documentation": "

\n The name of the custom line item.\n

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.billingconductor#CustomLineItemDescription", + "traits": { + "smithy.api#documentation": "

\n The description of the custom line item. This is shown on the Bills page in association with the charge value.\n

", + "smithy.api#required": {} + } + }, + "BillingGroupArn": { + "target": "com.amazonaws.billingconductor#BillingGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that references the billing group where the custom line\n item applies to.

", + "smithy.api#required": {} + } + }, + "BillingPeriodRange": { + "target": "com.amazonaws.billingconductor#CustomLineItemBillingPeriodRange", + "traits": { + "smithy.api#documentation": "

A time range for which the custom line item is effective.

" + } + }, + "Tags": { + "target": "com.amazonaws.billingconductor#TagMap", + "traits": { + "smithy.api#documentation": "

A map that contains tag keys and tag values that are attached to a custom line item.

" + } + }, + "ChargeDetails": { + "target": "com.amazonaws.billingconductor#CustomLineItemChargeDetails", + "traits": { + "smithy.api#documentation": "

\n A CustomLineItemChargeDetails that describes the charge details for a custom line item.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#references": [ + { + "resource": "com.amazonaws.billingconductor#BillingGroup", + "ids": { + "Arn": "BillingGroupArn" + } + } + ] + } + }, + "com.amazonaws.billingconductor#CreateCustomLineItemOutput": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.billingconductor#CustomLineItemArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the created custom line item.

" + } + } + } + }, + "com.amazonaws.billingconductor#CreatePricingPlan": { + "type": "operation", + "input": { + "target": "com.amazonaws.billingconductor#CreatePricingPlanInput" + }, + "output": { + "target": "com.amazonaws.billingconductor#CreatePricingPlanOutput" + }, + "errors": [ + { + "target": "com.amazonaws.billingconductor#AccessDeniedException" + }, + { + "target": "com.amazonaws.billingconductor#ConflictException" + }, + { + "target": "com.amazonaws.billingconductor#InternalServerException" + }, + { + "target": "com.amazonaws.billingconductor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.billingconductor#ServiceLimitExceededException" + }, + { + "target": "com.amazonaws.billingconductor#ThrottlingException" + }, + { + "target": "com.amazonaws.billingconductor#ValidationException" + } + ], + "traits": { + "aws.iam#conditionKeys": ["aws:TagKeys", "aws:RequestTag/${TagKey}"], + "smithy.api#documentation": "

Creates a pricing plan that is used for computing Amazon Web Services charges for billing groups.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/create-pricing-plan", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.billingconductor#CreatePricingPlanInput": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.billingconductor#ClientToken", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

\n The token that is needed to support idempotency. Idempotency isn't currently supported, but will be implemented in a future update. \n

", + "smithy.api#httpHeader": "X-Amzn-Client-Token", + "smithy.api#idempotencyToken": {} + } + }, + "Name": { + "target": "com.amazonaws.billingconductor#PricingPlanName", + "traits": { + "smithy.api#documentation": "

The pricing plan name. The names must be unique to each pricing plan.\n

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.billingconductor#PricingPlanDescription", + "traits": { + "smithy.api#documentation": "

The pricing plan description.\n

" + } + }, + "PricingRuleArns": { + "target": "com.amazonaws.billingconductor#PricingRuleArnsInput", + "traits": { + "smithy.api#documentation": "

A list of Amazon Resource Names (ARNs) that define the pricing plan parameters.

" + } + }, + "Tags": { + "target": "com.amazonaws.billingconductor#TagMap", + "traits": { + "smithy.api#documentation": "

\n A map that contains tag keys and tag values that are attached to a pricing plan.\n

" + } + } + } + }, + "com.amazonaws.billingconductor#CreatePricingPlanOutput": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.billingconductor#PricingPlanArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the created pricing plan.

" + } + } + } + }, + "com.amazonaws.billingconductor#CreatePricingRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.billingconductor#CreatePricingRuleInput" + }, + "output": { + "target": "com.amazonaws.billingconductor#CreatePricingRuleOutput" + }, + "errors": [ + { + "target": "com.amazonaws.billingconductor#AccessDeniedException" + }, + { + "target": "com.amazonaws.billingconductor#ConflictException" + }, + { + "target": "com.amazonaws.billingconductor#InternalServerException" + }, + { + "target": "com.amazonaws.billingconductor#ServiceLimitExceededException" + }, + { + "target": "com.amazonaws.billingconductor#ThrottlingException" + }, + { + "target": "com.amazonaws.billingconductor#ValidationException" + } + ], + "traits": { + "aws.iam#conditionKeys": ["aws:TagKeys", "aws:RequestTag/${TagKey}"], + "smithy.api#documentation": "

\n Creates a pricing rule can be associated to a pricing plan, or a set of pricing plans.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/create-pricing-rule", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.billingconductor#CreatePricingRuleInput": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.billingconductor#ClientToken", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

\n The token that is needed to support idempotency. Idempotency isn't currently supported, but will be implemented in a future update. \n

", + "smithy.api#httpHeader": "X-Amzn-Client-Token", + "smithy.api#idempotencyToken": {} + } + }, + "Name": { + "target": "com.amazonaws.billingconductor#PricingRuleName", + "traits": { + "smithy.api#documentation": "

\n The pricing rule name. The names must be unique to each pricing rule.\n

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.billingconductor#PricingRuleDescription", + "traits": { + "smithy.api#documentation": "

\n The pricing rule description.\n

" + } + }, + "Scope": { + "target": "com.amazonaws.billingconductor#PricingRuleScope", + "traits": { + "smithy.api#documentation": "

\n The scope of pricing rule that indicates if it is globally applicable, or is service-specific.\n

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.billingconductor#PricingRuleType", + "traits": { + "smithy.api#documentation": "

\n The type of pricing rule.\n

", + "smithy.api#required": {} + } + }, + "ModifierPercentage": { + "target": "com.amazonaws.billingconductor#ModifierPercentage", + "traits": { + "smithy.api#documentation": "

\n A percentage modifier applied on the public pricing rates.\n

", + "smithy.api#required": {} + } + }, + "Service": { + "target": "com.amazonaws.billingconductor#Service", + "traits": { + "smithy.api#documentation": "

\n If the Scope attribute is set to SERVICE, the attribute indicates which service the PricingRule is applicable for.\n

" + } + }, + "Tags": { + "target": "com.amazonaws.billingconductor#TagMap", + "traits": { + "smithy.api#documentation": "

\n A map that contains tag keys and tag values that are attached to a pricing rule.\n

" + } + } + } + }, + "com.amazonaws.billingconductor#CreatePricingRuleOutput": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.billingconductor#PricingRuleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the created pricing rule.

" + } + } + } + }, + "com.amazonaws.billingconductor#Currency": { + "type": "string" + }, + "com.amazonaws.billingconductor#CurrencyCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "USD", + "name": "USD" + }, + { + "value": "CNY", + "name": "CNY" + } + ] + } + }, + "com.amazonaws.billingconductor#CustomLineItem": { + "type": "resource", + "identifiers": { + "Arn": { + "target": "com.amazonaws.billingconductor#CustomLineItemArn" + } + }, + "create": { + "target": "com.amazonaws.billingconductor#CreateCustomLineItem" + }, + "update": { + "target": "com.amazonaws.billingconductor#UpdateCustomLineItem" + }, + "delete": { + "target": "com.amazonaws.billingconductor#DeleteCustomLineItem" + }, + "list": { + "target": "com.amazonaws.billingconductor#ListCustomLineItems" + }, + "operations": [ + { + "target": "com.amazonaws.billingconductor#BatchAssociateResourcesToCustomLineItem" + }, + { + "target": "com.amazonaws.billingconductor#BatchDisassociateResourcesFromCustomLineItem" + }, + { + "target": "com.amazonaws.billingconductor#ListResourcesAssociatedToCustomLineItem" + } + ], + "traits": { + "aws.iam#conditionKeys": ["aws:ResourceTag/${TagKey}"], + "aws.iam#disableConditionKeyInference": {}, + "smithy.api#documentation": "Represents the custom line item\n" + } + }, + "com.amazonaws.billingconductor#CustomLineItemArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(arn:aws:billingconductor::[0-9]{12}:customlineitem/)?[a-zA-Z0-9]{10}$" + } + }, + "com.amazonaws.billingconductor#CustomLineItemArns": { + "type": "list", + "member": { + "target": "com.amazonaws.billingconductor#CustomLineItemArn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.billingconductor#CustomLineItemAssociationElement": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(arn:aws:billingconductor::[0-9]{12}:(customlineitem|billinggroup)/)?[a-zA-Z0-9]{10,12}$" + } + }, + "com.amazonaws.billingconductor#CustomLineItemAssociationsList": { + "type": "list", + "member": { + "target": "com.amazonaws.billingconductor#CustomLineItemAssociationElement" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.billingconductor#CustomLineItemBatchAssociationsList": { + "type": "list", + "member": { + "target": "com.amazonaws.billingconductor#CustomLineItemAssociationElement" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30 + } + } + }, + "com.amazonaws.billingconductor#CustomLineItemBatchDisassociationsList": { + "type": "list", + "member": { + "target": "com.amazonaws.billingconductor#CustomLineItemAssociationElement" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30 + } + } + }, + "com.amazonaws.billingconductor#CustomLineItemBillingPeriodRange": { + "type": "structure", + "members": { + "InclusiveStartBillingPeriod": { + "target": "com.amazonaws.billingconductor#BillingPeriod", + "traits": { + "smithy.api#documentation": "

\n The inclusive start billing period that defines a billing period range where a custom line is applied.\n

", + "smithy.api#required": {} + } + }, + "ExclusiveEndBillingPeriod": { + "target": "com.amazonaws.billingconductor#BillingPeriod", + "traits": { + "smithy.api#documentation": "

\n The inclusive end billing period that defines a billing period range where a custom line is applied.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The billing period range in which the custom line item request will be applied.\n

" + } + }, + "com.amazonaws.billingconductor#CustomLineItemChargeDetails": { + "type": "structure", + "members": { + "Flat": { + "target": "com.amazonaws.billingconductor#CustomLineItemFlatChargeDetails", + "traits": { + "smithy.api#documentation": "

\n A CustomLineItemFlatChargeDetails that describes the charge details of a flat custom line item.\n

" + } + }, + "Percentage": { + "target": "com.amazonaws.billingconductor#CustomLineItemPercentageChargeDetails", + "traits": { + "smithy.api#documentation": "

\n A CustomLineItemPercentageChargeDetails that describes the charge details of a percentage custom line item.\n

" + } + }, + "Type": { + "target": "com.amazonaws.billingconductor#CustomLineItemType", + "traits": { + "smithy.api#documentation": "

\n The type of the custom line item that indicates whether the charge is a fee or credit.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The charge details of a custom line item. It should contain only one of Flat or Percentage.\n

" + } + }, + "com.amazonaws.billingconductor#CustomLineItemChargeValue": { + "type": "double", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 1000000 + } + } + }, + "com.amazonaws.billingconductor#CustomLineItemDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.billingconductor#CustomLineItemFlatChargeDetails": { + "type": "structure", + "members": { + "ChargeValue": { + "target": "com.amazonaws.billingconductor#CustomLineItemChargeValue", + "traits": { + "smithy.api#documentation": "

\n The custom line item's fixed charge value in USD.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

\n A representation of the charge details associated with a flat custom line item.\n

" + } + }, + "com.amazonaws.billingconductor#CustomLineItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.billingconductor#CustomLineItemListElement" + } + }, + "com.amazonaws.billingconductor#CustomLineItemListElement": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.billingconductor#CustomLineItemArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) for custom line items.

" + } + }, + "Name": { + "target": "com.amazonaws.billingconductor#CustomLineItemName", + "traits": { + "smithy.api#documentation": "

\n The custom line item's name.\n

" + } + }, + "ChargeDetails": { + "target": "com.amazonaws.billingconductor#ListCustomLineItemChargeDetails", + "traits": { + "smithy.api#documentation": "

\n A ListCustomLineItemChargeDetails that describes the charge details of a custom line item.\n

" + } + }, + "CurrencyCode": { + "target": "com.amazonaws.billingconductor#CurrencyCode", + "traits": { + "smithy.api#documentation": "

\n The custom line item's charge value currency. Only one of the valid values can be used.\n

" + } + }, + "Description": { + "target": "com.amazonaws.billingconductor#CustomLineItemDescription", + "traits": { + "smithy.api#documentation": "

\n The custom line item's description. This is shown on the Bills page in association with the charge value.\n

" + } + }, + "ProductCode": { + "target": "com.amazonaws.billingconductor#CustomLineItemProductCode", + "traits": { + "smithy.api#documentation": "

\n The product code associated with the custom line item.\n

" + } + }, + "BillingGroupArn": { + "target": "com.amazonaws.billingconductor#BillingGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that references the billing group where the custom line\n item applies to.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.billingconductor#Instant", + "traits": { + "smithy.api#documentation": "

\n The time created.\n

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.billingconductor#Instant", + "traits": { + "smithy.api#documentation": "

\n The most recent time the custom line item was modified.\n

" + } + }, + "AssociationSize": { + "target": "com.amazonaws.billingconductor#NumberOfAssociations", + "traits": { + "smithy.api#documentation": "

\n The number of resources that are associated to the custom line item.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n A representation of a custom line item.\n

" + } + }, + "com.amazonaws.billingconductor#CustomLineItemName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_\\+=\\.\\-@]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.billingconductor#CustomLineItemNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.billingconductor#CustomLineItemName" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.billingconductor#CustomLineItemPercentageChargeDetails": { + "type": "structure", + "members": { + "PercentageValue": { + "target": "com.amazonaws.billingconductor#CustomLineItemPercentageChargeValue", + "traits": { + "smithy.api#documentation": "

\n The custom line item's percentage value. This will be multiplied against the combined value of its associated resources to determine its charge value.\n

", + "smithy.api#required": {} + } + }, + "AssociatedValues": { + "target": "com.amazonaws.billingconductor#CustomLineItemAssociationsList", + "traits": { + "smithy.api#documentation": "

\n A list of resource ARNs to associate to the percentage custom line item.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n A representation of the charge details associated with a percentage custom line item.\n

" + } + }, + "com.amazonaws.billingconductor#CustomLineItemPercentageChargeValue": { + "type": "double", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 10000 + } + } + }, + "com.amazonaws.billingconductor#CustomLineItemProductCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 29 + } + } + }, + "com.amazonaws.billingconductor#CustomLineItemRelationship": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PARENT", + "name": "PARENT" + }, + { + "value": "CHILD", + "name": "CHILD" + } + ] + } + }, + "com.amazonaws.billingconductor#CustomLineItemType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREDIT", + "name": "CREDIT" + }, + { + "value": "FEE", + "name": "FEE" + } + ] + } + }, + "com.amazonaws.billingconductor#DeleteBillingGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.billingconductor#DeleteBillingGroupInput" + }, + "output": { + "target": "com.amazonaws.billingconductor#DeleteBillingGroupOutput" + }, + "errors": [ + { + "target": "com.amazonaws.billingconductor#AccessDeniedException" + }, + { + "target": "com.amazonaws.billingconductor#InternalServerException" + }, + { + "target": "com.amazonaws.billingconductor#ThrottlingException" + }, + { + "target": "com.amazonaws.billingconductor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Deletes a billing group.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/delete-billing-group", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.billingconductor#DeleteBillingGroupInput": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.billingconductor#BillingGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the billing group you're deleting.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.billingconductor#DeleteBillingGroupOutput": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.billingconductor#BillingGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the deleted billing group.

" + } + } + } + }, + "com.amazonaws.billingconductor#DeleteCustomLineItem": { + "type": "operation", + "input": { + "target": "com.amazonaws.billingconductor#DeleteCustomLineItemInput" + }, + "output": { + "target": "com.amazonaws.billingconductor#DeleteCustomLineItemOutput" + }, + "errors": [ + { + "target": "com.amazonaws.billingconductor#AccessDeniedException" + }, + { + "target": "com.amazonaws.billingconductor#ConflictException" + }, + { + "target": "com.amazonaws.billingconductor#InternalServerException" + }, + { + "target": "com.amazonaws.billingconductor#ThrottlingException" + }, + { + "target": "com.amazonaws.billingconductor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Deletes the custom line item identified by the given ARN in the current, or previous billing period.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/delete-custom-line-item", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.billingconductor#DeleteCustomLineItemInput": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.billingconductor#CustomLineItemArn", + "traits": { + "smithy.api#documentation": "

\n The ARN of the custom line item to be deleted.\n

", + "smithy.api#required": {} + } + }, + "BillingPeriodRange": { + "target": "com.amazonaws.billingconductor#CustomLineItemBillingPeriodRange" + } + } + }, + "com.amazonaws.billingconductor#DeleteCustomLineItemOutput": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.billingconductor#CustomLineItemArn", + "traits": { + "smithy.api#documentation": "

\n Then ARN of the deleted custom line item.\n

" + } + } + } + }, + "com.amazonaws.billingconductor#DeletePricingPlan": { + "type": "operation", + "input": { + "target": "com.amazonaws.billingconductor#DeletePricingPlanInput" + }, + "output": { + "target": "com.amazonaws.billingconductor#DeletePricingPlanOutput" + }, + "errors": [ + { + "target": "com.amazonaws.billingconductor#AccessDeniedException" + }, + { + "target": "com.amazonaws.billingconductor#ConflictException" + }, + { + "target": "com.amazonaws.billingconductor#InternalServerException" + }, + { + "target": "com.amazonaws.billingconductor#ThrottlingException" + }, + { + "target": "com.amazonaws.billingconductor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a pricing plan. The pricing plan must not be associated with any billing groups to\n delete successfully.

", + "smithy.api#http": { + "method": "POST", + "uri": "/delete-pricing-plan", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.billingconductor#DeletePricingPlanInput": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.billingconductor#PricingPlanArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the pricing plan you're deleting.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.billingconductor#DeletePricingPlanOutput": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.billingconductor#PricingPlanArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the deleted pricing plan.

" + } + } + } + }, + "com.amazonaws.billingconductor#DeletePricingRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.billingconductor#DeletePricingRuleInput" + }, + "output": { + "target": "com.amazonaws.billingconductor#DeletePricingRuleOutput" + }, + "errors": [ + { + "target": "com.amazonaws.billingconductor#AccessDeniedException" + }, + { + "target": "com.amazonaws.billingconductor#ConflictException" + }, + { + "target": "com.amazonaws.billingconductor#InternalServerException" + }, + { + "target": "com.amazonaws.billingconductor#ThrottlingException" + }, + { + "target": "com.amazonaws.billingconductor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the pricing rule identified by the input Amazon Resource Name (ARN).

", + "smithy.api#http": { + "method": "POST", + "uri": "/delete-pricing-rule", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.billingconductor#DeletePricingRuleInput": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.billingconductor#PricingRuleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the pricing rule you are deleting.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.billingconductor#DeletePricingRuleOutput": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.billingconductor#PricingRuleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the deleted pricing rule.

" + } + } + } + }, + "com.amazonaws.billingconductor#DisassociateAccounts": { + "type": "operation", + "input": { + "target": "com.amazonaws.billingconductor#DisassociateAccountsInput" + }, + "output": { + "target": "com.amazonaws.billingconductor#DisassociateAccountsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.billingconductor#AccessDeniedException" + }, + { + "target": "com.amazonaws.billingconductor#ConflictException" + }, + { + "target": "com.amazonaws.billingconductor#InternalServerException" + }, + { + "target": "com.amazonaws.billingconductor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.billingconductor#ThrottlingException" + }, + { + "target": "com.amazonaws.billingconductor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the specified list of account IDs from the given billing group.

", + "smithy.api#http": { + "method": "POST", + "uri": "/disassociate-accounts", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.billingconductor#DisassociateAccountsInput": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.billingconductor#BillingGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the billing group that the array of account IDs will\n disassociate from.

", + "smithy.api#required": {} + } + }, + "AccountIds": { + "target": "com.amazonaws.billingconductor#AccountIdList", + "traits": { + "smithy.api#documentation": "

The array of account IDs to disassociate.\n

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.billingconductor#DisassociateAccountsOutput": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.billingconductor#BillingGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the billing group that the array of account IDs is\n disassociated from.

" + } + } + } + }, + "com.amazonaws.billingconductor#DisassociatePricingRules": { + "type": "operation", + "input": { + "target": "com.amazonaws.billingconductor#DisassociatePricingRulesInput" + }, + "output": { + "target": "com.amazonaws.billingconductor#DisassociatePricingRulesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.billingconductor#AccessDeniedException" + }, + { + "target": "com.amazonaws.billingconductor#ConflictException" + }, + { + "target": "com.amazonaws.billingconductor#InternalServerException" + }, + { + "target": "com.amazonaws.billingconductor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.billingconductor#ThrottlingException" + }, + { + "target": "com.amazonaws.billingconductor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Disassociates a list of pricing rules from a pricing plan.\n

", + "smithy.api#http": { + "method": "PUT", + "uri": "/disassociate-pricing-rules", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.billingconductor#DisassociatePricingRulesInput": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.billingconductor#PricingPlanArn", + "traits": { + "smithy.api#documentation": "

The pricing plan Amazon Resource Name (ARN) to disassociate pricing rules from.

", + "smithy.api#required": {} + } + }, + "PricingRuleArns": { + "target": "com.amazonaws.billingconductor#PricingRuleArnsNonEmptyInput", + "traits": { + "smithy.api#documentation": "

A list containing the Amazon Resource Name (ARN) of the pricing rules that will be\n disassociated.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.billingconductor#DisassociatePricingRulesOutput": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.billingconductor#PricingPlanArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the pricing plan that the pricing rules successfully\n disassociated from.

" + } + } + } + }, + "com.amazonaws.billingconductor#DisassociateResourceResponseElement": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.billingconductor#CustomLineItemArn", + "traits": { + "smithy.api#documentation": "

\n The resource ARN that was disassociated from the custom line item.\n

" + } + }, + "Error": { + "target": "com.amazonaws.billingconductor#AssociateResourceError", + "traits": { + "smithy.api#documentation": "

\n An AssociateResourceError shown if the resource disassociation fails.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n A resource disassociation result for a percentage custom line item.\n

" + } + }, + "com.amazonaws.billingconductor#DisassociateResourcesResponseList": { + "type": "list", + "member": { + "target": "com.amazonaws.billingconductor#DisassociateResourceResponseElement" + } + }, + "com.amazonaws.billingconductor#Instant": { + "type": "long" + }, + "com.amazonaws.billingconductor#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.billingconductor#String", + "traits": { + "smithy.api#required": {} + } + }, + "RetryAfterSeconds": { + "target": "com.amazonaws.billingconductor#RetryAfterSeconds", + "traits": { + "smithy.api#documentation": "

Number of seconds you can retry after the call.\n

", + "smithy.api#httpHeader": "Retry-After" + } + } + }, + "traits": { + "smithy.api#documentation": "

An unexpected error occurred while processing a request.\n

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.billingconductor#ListAccountAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.billingconductor#ListAccountAssociationsInput" + }, + "output": { + "target": "com.amazonaws.billingconductor#ListAccountAssociationsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.billingconductor#AccessDeniedException" + }, + { + "target": "com.amazonaws.billingconductor#InternalServerException" + }, + { + "target": "com.amazonaws.billingconductor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.billingconductor#ThrottlingException" + }, + { + "target": "com.amazonaws.billingconductor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n \n Amazon Web Services Billing Conductor is in beta release and is subject to change. Your use of Amazon Web Services Billing Conductor is subject to the Beta Service Participation terms of the Amazon Web Services Service Terms (Section 1.10).\n \n

\n

This is a paginated call to list linked accounts that are linked to the payer account for\n the specified time period. If no information is provided, the current billing period is used.\n The response will optionally include the billing group associated with the linked\n account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/list-account-associations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "LinkedAccounts" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.billingconductor#ListAccountAssociationsFilter": { + "type": "structure", + "members": { + "Association": { + "target": "com.amazonaws.billingconductor#Association", + "traits": { + "smithy.api#documentation": "

\n MONITORED: linked accounts that are associated to billing groups.

\n

\n UNMONITORED: linked accounts that are not associated to billing\n groups.

\n

\n Billing Group Arn: linked accounts that are associated to the provided\n Billing Group Arn.

" + } + }, + "AccountId": { + "target": "com.amazonaws.billingconductor#AccountId", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Services account ID to filter on.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The filter on the account ID of the linked account, or any of the following:

\n

\n MONITORED: linked accounts that are associated to billing groups.

\n

\n UNMONITORED: linked accounts that are not associated to billing\n groups.

\n

\n Billing Group Arn: linked accounts that are associated to the provided\n Billing Group Arn.

" + } + }, + "com.amazonaws.billingconductor#ListAccountAssociationsInput": { + "type": "structure", + "members": { + "BillingPeriod": { + "target": "com.amazonaws.billingconductor#BillingPeriod", + "traits": { + "smithy.api#documentation": "

\n The preferred billing period to get account associations.\n

" + } + }, + "Filters": { + "target": "com.amazonaws.billingconductor#ListAccountAssociationsFilter", + "traits": { + "smithy.api#documentation": "

The filter on the account ID of the linked account, or any of the following:

\n

\n MONITORED: linked accounts that are associated to billing groups.

\n

\n UNMONITORED: linked accounts that are not associated to billing\n groups.

\n

\n Billing Group Arn: linked accounts that are associated to the provided\n billing group Arn.

" + } + }, + "NextToken": { + "target": "com.amazonaws.billingconductor#Token", + "traits": { + "smithy.api#documentation": "

\n The pagination token used on subsequent calls to retrieve accounts.\n

" + } + } + } + }, + "com.amazonaws.billingconductor#ListAccountAssociationsOutput": { + "type": "structure", + "members": { + "LinkedAccounts": { + "target": "com.amazonaws.billingconductor#AccountAssociationsList", + "traits": { + "smithy.api#documentation": "

The list of linked accounts in the payer account.

" + } + }, + "NextToken": { + "target": "com.amazonaws.billingconductor#Token", + "traits": { + "smithy.api#documentation": "

\n The pagination token used on subsequent calls to get accounts.\n

" + } + } + } + }, + "com.amazonaws.billingconductor#ListBillingGroupCostReports": { + "type": "operation", + "input": { + "target": "com.amazonaws.billingconductor#ListBillingGroupCostReportsInput" + }, + "output": { + "target": "com.amazonaws.billingconductor#ListBillingGroupCostReportsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.billingconductor#AccessDeniedException" + }, + { + "target": "com.amazonaws.billingconductor#InternalServerException" + }, + { + "target": "com.amazonaws.billingconductor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.billingconductor#ThrottlingException" + }, + { + "target": "com.amazonaws.billingconductor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

A paginated call to retrieve a summary report of actual Amazon Web Services charges and the calculated\n Amazon Web Services charges based on the associated pricing plan of a billing group.

", + "smithy.api#http": { + "method": "POST", + "uri": "/list-billing-group-cost-reports", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "BillingGroupCostReports" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.billingconductor#ListBillingGroupCostReportsFilter": { + "type": "structure", + "members": { + "BillingGroupArns": { + "target": "com.amazonaws.billingconductor#BillingGroupArnList", + "traits": { + "smithy.api#documentation": "

The list of Amazon Resource Names (ARNs) used to filter billing groups to retrieve\n reports.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The filter used to retrieve specific BillingGroupCostReportElements.\n

" + } + }, + "com.amazonaws.billingconductor#ListBillingGroupCostReportsInput": { + "type": "structure", + "members": { + "BillingPeriod": { + "target": "com.amazonaws.billingconductor#BillingPeriod", + "traits": { + "smithy.api#documentation": "

The preferred billing period for your report.\n

" + } + }, + "MaxResults": { + "target": "com.amazonaws.billingconductor#MaxBillingGroupResults", + "traits": { + "smithy.api#documentation": "

The maximum number of reports to retrieve.\n

" + } + }, + "NextToken": { + "target": "com.amazonaws.billingconductor#Token", + "traits": { + "smithy.api#documentation": "

The pagination token used on subsequent calls to get reports.\n

" + } + }, + "Filters": { + "target": "com.amazonaws.billingconductor#ListBillingGroupCostReportsFilter", + "traits": { + "smithy.api#documentation": "

A ListBillingGroupCostReportsFilter to specify billing groups to retrieve reports from.\n

" + } + } + } + }, + "com.amazonaws.billingconductor#ListBillingGroupCostReportsOutput": { + "type": "structure", + "members": { + "BillingGroupCostReports": { + "target": "com.amazonaws.billingconductor#BillingGroupCostReportList", + "traits": { + "smithy.api#documentation": "

A list of BillingGroupCostReportElement retrieved.\n

" + } + }, + "NextToken": { + "target": "com.amazonaws.billingconductor#Token", + "traits": { + "smithy.api#documentation": "

The pagination token used on subsequent calls to get reports.\n

" + } + } + } + }, + "com.amazonaws.billingconductor#ListBillingGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.billingconductor#ListBillingGroupsInput" + }, + "output": { + "target": "com.amazonaws.billingconductor#ListBillingGroupsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.billingconductor#AccessDeniedException" + }, + { + "target": "com.amazonaws.billingconductor#InternalServerException" + }, + { + "target": "com.amazonaws.billingconductor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.billingconductor#ThrottlingException" + }, + { + "target": "com.amazonaws.billingconductor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

A paginated call to retrieve a list of billing groups for the given billing period. If you don't provide a billing group, the current billing period is used.

", + "smithy.api#http": { + "method": "POST", + "uri": "/list-billing-groups", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "BillingGroups" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.billingconductor#ListBillingGroupsFilter": { + "type": "structure", + "members": { + "Arns": { + "target": "com.amazonaws.billingconductor#BillingGroupArnList", + "traits": { + "smithy.api#documentation": "

The list of billing group Amazon Resource Names (ARNs) to retrieve information.

" + } + }, + "PricingPlan": { + "target": "com.amazonaws.billingconductor#PricingPlanFullArn", + "traits": { + "smithy.api#documentation": "

The pricing plan Amazon Resource Names (ARNs) to retrieve information.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The filter that specifies the billing groups and pricing plans to retrieve billing group information.\n

" + } + }, + "com.amazonaws.billingconductor#ListBillingGroupsInput": { + "type": "structure", + "members": { + "BillingPeriod": { + "target": "com.amazonaws.billingconductor#BillingPeriod", + "traits": { + "smithy.api#documentation": "

The preferred billing period to get billing groups.\n

" + } + }, + "MaxResults": { + "target": "com.amazonaws.billingconductor#MaxBillingGroupResults", + "traits": { + "smithy.api#documentation": "

The maximum number of billing groups to retrieve.\n

" + } + }, + "NextToken": { + "target": "com.amazonaws.billingconductor#Token", + "traits": { + "smithy.api#documentation": "

The pagination token used on subsequent calls to get billing groups.\n

" + } + }, + "Filters": { + "target": "com.amazonaws.billingconductor#ListBillingGroupsFilter", + "traits": { + "smithy.api#documentation": "

A ListBillingGroupsFilter that specifies the billing group and pricing plan to retrieve billing group information.\n

" + } + } + } + }, + "com.amazonaws.billingconductor#ListBillingGroupsOutput": { + "type": "structure", + "members": { + "BillingGroups": { + "target": "com.amazonaws.billingconductor#BillingGroupList", + "traits": { + "smithy.api#documentation": "

A list of BillingGroupListElement retrieved.\n

" + } + }, + "NextToken": { + "target": "com.amazonaws.billingconductor#Token", + "traits": { + "smithy.api#documentation": "

The pagination token used on subsequent calls to get billing groups.\n

" + } + } + } + }, + "com.amazonaws.billingconductor#ListCustomLineItemChargeDetails": { + "type": "structure", + "members": { + "Flat": { + "target": "com.amazonaws.billingconductor#ListCustomLineItemFlatChargeDetails", + "traits": { + "smithy.api#documentation": "

\n A ListCustomLineItemFlatChargeDetails that describes the charge details of a flat custom line item.\n

" + } + }, + "Percentage": { + "target": "com.amazonaws.billingconductor#ListCustomLineItemPercentageChargeDetails", + "traits": { + "smithy.api#documentation": "

\n A ListCustomLineItemPercentageChargeDetails that describes the charge details of a percentage custom line item.\n

" + } + }, + "Type": { + "target": "com.amazonaws.billingconductor#CustomLineItemType", + "traits": { + "smithy.api#documentation": "

\n The type of the custom line item that indicates whether the charge is a fee or credit.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

\n A representation of the charge details of a custom line item.\n

" + } + }, + "com.amazonaws.billingconductor#ListCustomLineItemFlatChargeDetails": { + "type": "structure", + "members": { + "ChargeValue": { + "target": "com.amazonaws.billingconductor#CustomLineItemChargeValue", + "traits": { + "smithy.api#documentation": "

\n The custom line item's fixed charge value in USD.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

\n A representation of the charge details associated with a flat custom line item.\n

" + } + }, + "com.amazonaws.billingconductor#ListCustomLineItemPercentageChargeDetails": { + "type": "structure", + "members": { + "PercentageValue": { + "target": "com.amazonaws.billingconductor#CustomLineItemPercentageChargeValue", + "traits": { + "smithy.api#documentation": "

\n The custom line item's percentage value. This will be multiplied against the combined value of its associated resources to determine its charge value.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

\n A representation of the charge details associated with a percentage custom line item.\n

" + } + }, + "com.amazonaws.billingconductor#ListCustomLineItems": { + "type": "operation", + "input": { + "target": "com.amazonaws.billingconductor#ListCustomLineItemsInput" + }, + "output": { + "target": "com.amazonaws.billingconductor#ListCustomLineItemsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.billingconductor#AccessDeniedException" + }, + { + "target": "com.amazonaws.billingconductor#InternalServerException" + }, + { + "target": "com.amazonaws.billingconductor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.billingconductor#ThrottlingException" + }, + { + "target": "com.amazonaws.billingconductor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n A paginated call to get a list of all custom line items (FFLIs) for the given billing period. If you don't provide a billing period, the current billing period is used.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/list-custom-line-items", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "CustomLineItems" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.billingconductor#ListCustomLineItemsFilter": { + "type": "structure", + "members": { + "Names": { + "target": "com.amazonaws.billingconductor#CustomLineItemNameList", + "traits": { + "smithy.api#documentation": "

\n A list of custom line items to retrieve information.\n

" + } + }, + "BillingGroups": { + "target": "com.amazonaws.billingconductor#BillingGroupArnList", + "traits": { + "smithy.api#documentation": "

The billing group Amazon Resource Names (ARNs) to retrieve information.

" + } + }, + "Arns": { + "target": "com.amazonaws.billingconductor#CustomLineItemArns", + "traits": { + "smithy.api#documentation": "

\n A list of custom line item ARNs to retrieve information.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n A filter that specifies the custom line items and billing groups to retrieve FFLI information.\n

" + } + }, + "com.amazonaws.billingconductor#ListCustomLineItemsInput": { + "type": "structure", + "members": { + "BillingPeriod": { + "target": "com.amazonaws.billingconductor#BillingPeriod", + "traits": { + "smithy.api#documentation": "

\n The preferred billing period to get custom line items (FFLIs).\n

" + } + }, + "MaxResults": { + "target": "com.amazonaws.billingconductor#MaxBillingGroupResults", + "traits": { + "smithy.api#documentation": "

\n The maximum number of billing groups to retrieve.\n

" + } + }, + "NextToken": { + "target": "com.amazonaws.billingconductor#Token", + "traits": { + "smithy.api#documentation": "

\n The pagination token used on subsequent calls to get custom line items (FFLIs).\n

" + } + }, + "Filters": { + "target": "com.amazonaws.billingconductor#ListCustomLineItemsFilter", + "traits": { + "smithy.api#documentation": "

A ListCustomLineItemsFilter that specifies the custom line item names\n and/or billing group Amazon Resource Names (ARNs) to retrieve FFLI information.

" + } + } + } + }, + "com.amazonaws.billingconductor#ListCustomLineItemsOutput": { + "type": "structure", + "members": { + "CustomLineItems": { + "target": "com.amazonaws.billingconductor#CustomLineItemList", + "traits": { + "smithy.api#documentation": "

\n A list of FreeFormLineItemListElements received.\n

" + } + }, + "NextToken": { + "target": "com.amazonaws.billingconductor#Token", + "traits": { + "smithy.api#documentation": "

\n The pagination token used on subsequent calls to get custom line items (FFLIs).\n

" + } + } + } + }, + "com.amazonaws.billingconductor#ListPricingPlans": { + "type": "operation", + "input": { + "target": "com.amazonaws.billingconductor#ListPricingPlansInput" + }, + "output": { + "target": "com.amazonaws.billingconductor#ListPricingPlansOutput" + }, + "errors": [ + { + "target": "com.amazonaws.billingconductor#AccessDeniedException" + }, + { + "target": "com.amazonaws.billingconductor#InternalServerException" + }, + { + "target": "com.amazonaws.billingconductor#ThrottlingException" + }, + { + "target": "com.amazonaws.billingconductor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

A paginated call to get pricing plans for the given billing period. If you don't provide a billing period, the current billing period is used.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/list-pricing-plans", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "PricingPlans" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.billingconductor#ListPricingPlansAssociatedWithPricingRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.billingconductor#ListPricingPlansAssociatedWithPricingRuleInput" + }, + "output": { + "target": "com.amazonaws.billingconductor#ListPricingPlansAssociatedWithPricingRuleOutput" + }, + "errors": [ + { + "target": "com.amazonaws.billingconductor#AccessDeniedException" + }, + { + "target": "com.amazonaws.billingconductor#InternalServerException" + }, + { + "target": "com.amazonaws.billingconductor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.billingconductor#ThrottlingException" + }, + { + "target": "com.amazonaws.billingconductor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n A list of the pricing plans associated with a pricing rule.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/list-pricing-plans-associated-with-pricing-rule", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "PricingPlanArns" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.billingconductor#ListPricingPlansAssociatedWithPricingRuleInput": { + "type": "structure", + "members": { + "BillingPeriod": { + "target": "com.amazonaws.billingconductor#BillingPeriod", + "traits": { + "smithy.api#documentation": "

\n The pricing plan billing period for which associations will be listed.\n

" + } + }, + "PricingRuleArn": { + "target": "com.amazonaws.billingconductor#PricingRuleArn", + "traits": { + "smithy.api#documentation": "

The pricing rule Amazon Resource Name (ARN) for which associations will be listed.

", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.billingconductor#MaxPricingRuleResults", + "traits": { + "smithy.api#documentation": "

\n The optional maximum number of pricing rule associations to retrieve. \n

" + } + }, + "NextToken": { + "target": "com.amazonaws.billingconductor#Token", + "traits": { + "smithy.api#documentation": "

\n The optional pagination token returned by a previous call.\n

" + } + } + } + }, + "com.amazonaws.billingconductor#ListPricingPlansAssociatedWithPricingRuleOutput": { + "type": "structure", + "members": { + "BillingPeriod": { + "target": "com.amazonaws.billingconductor#BillingPeriod", + "traits": { + "smithy.api#documentation": "

\n The pricing plan billing period for which associations will be listed.\n

" + } + }, + "PricingRuleArn": { + "target": "com.amazonaws.billingconductor#PricingRuleArn", + "traits": { + "smithy.api#documentation": "

The pricing rule Amazon Resource Name (ARN) for which associations will be listed.

" + } + }, + "PricingPlanArns": { + "target": "com.amazonaws.billingconductor#PricingPlanArns", + "traits": { + "smithy.api#documentation": "

\n The list containing pricing plans associated with the requested pricing rule.\n

" + } + }, + "NextToken": { + "target": "com.amazonaws.billingconductor#Token", + "traits": { + "smithy.api#documentation": "

\n The pagination token to be used on subsequent calls.\n

" + } + } + } + }, + "com.amazonaws.billingconductor#ListPricingPlansFilter": { + "type": "structure", + "members": { + "Arns": { + "target": "com.amazonaws.billingconductor#PricingPlanArns", + "traits": { + "smithy.api#documentation": "

A list of pricing plan Amazon Resource Names (ARNs) to retrieve information.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The filter that specifies the Amazon Resource Names (ARNs) of pricing plans, to retrieve\n pricing plan information.

" + } + }, + "com.amazonaws.billingconductor#ListPricingPlansInput": { + "type": "structure", + "members": { + "BillingPeriod": { + "target": "com.amazonaws.billingconductor#BillingPeriod", + "traits": { + "smithy.api#documentation": "

The preferred billing period to get pricing plan.\n

" + } + }, + "Filters": { + "target": "com.amazonaws.billingconductor#ListPricingPlansFilter", + "traits": { + "smithy.api#documentation": "

A ListPricingPlansFilter that specifies the Amazon Resource Name (ARNs)\n of pricing plans to retrieve pricing plans information.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.billingconductor#MaxPricingPlanResults", + "traits": { + "smithy.api#documentation": "

The maximum number of pricing plans to retrieve.

" + } + }, + "NextToken": { + "target": "com.amazonaws.billingconductor#Token", + "traits": { + "smithy.api#documentation": "

The pagination token used on subsequent call to get pricing plans.\n

" + } + } + } + }, + "com.amazonaws.billingconductor#ListPricingPlansOutput": { + "type": "structure", + "members": { + "BillingPeriod": { + "target": "com.amazonaws.billingconductor#BillingPeriod", + "traits": { + "smithy.api#documentation": "

\n The billing period for which the described pricing plans are applicable.\n

" + } + }, + "PricingPlans": { + "target": "com.amazonaws.billingconductor#PricingPlanList", + "traits": { + "smithy.api#documentation": "

A list of PricingPlanListElement retrieved.\n

" + } + }, + "NextToken": { + "target": "com.amazonaws.billingconductor#Token", + "traits": { + "smithy.api#documentation": "

The pagination token used on subsequent calls to get pricing plans.\n

" + } + } + } + }, + "com.amazonaws.billingconductor#ListPricingRules": { + "type": "operation", + "input": { + "target": "com.amazonaws.billingconductor#ListPricingRulesInput" + }, + "output": { + "target": "com.amazonaws.billingconductor#ListPricingRulesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.billingconductor#AccessDeniedException" + }, + { + "target": "com.amazonaws.billingconductor#InternalServerException" + }, + { + "target": "com.amazonaws.billingconductor#ThrottlingException" + }, + { + "target": "com.amazonaws.billingconductor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Describes a pricing rule that can be associated to a pricing plan, or set of pricing plans.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/list-pricing-rules", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "PricingRules" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.billingconductor#ListPricingRulesAssociatedToPricingPlan": { + "type": "operation", + "input": { + "target": "com.amazonaws.billingconductor#ListPricingRulesAssociatedToPricingPlanInput" + }, + "output": { + "target": "com.amazonaws.billingconductor#ListPricingRulesAssociatedToPricingPlanOutput" + }, + "errors": [ + { + "target": "com.amazonaws.billingconductor#AccessDeniedException" + }, + { + "target": "com.amazonaws.billingconductor#InternalServerException" + }, + { + "target": "com.amazonaws.billingconductor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.billingconductor#ThrottlingException" + }, + { + "target": "com.amazonaws.billingconductor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Lists the pricing rules associated with a pricing plan.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/list-pricing-rules-associated-to-pricing-plan", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "PricingRuleArns" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.billingconductor#ListPricingRulesAssociatedToPricingPlanInput": { + "type": "structure", + "members": { + "BillingPeriod": { + "target": "com.amazonaws.billingconductor#BillingPeriod", + "traits": { + "smithy.api#documentation": "

\n The billing period for which the pricing rule associations are to be listed.\n

" + } + }, + "PricingPlanArn": { + "target": "com.amazonaws.billingconductor#PricingPlanArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the pricing plan for which associations are to be\n listed.

", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.billingconductor#MaxPricingPlanResults", + "traits": { + "smithy.api#documentation": "

The optional maximum number of pricing rule associations to retrieve.

" + } + }, + "NextToken": { + "target": "com.amazonaws.billingconductor#Token", + "traits": { + "smithy.api#documentation": "

\n The optional pagination token returned by a previous call.\n

" + } + } + } + }, + "com.amazonaws.billingconductor#ListPricingRulesAssociatedToPricingPlanOutput": { + "type": "structure", + "members": { + "BillingPeriod": { + "target": "com.amazonaws.billingconductor#BillingPeriod", + "traits": { + "smithy.api#documentation": "

\n The billing period for which the pricing rule associations are listed.\n

" + } + }, + "PricingPlanArn": { + "target": "com.amazonaws.billingconductor#PricingPlanArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the pricing plan for which associations are\n listed.

" + } + }, + "PricingRuleArns": { + "target": "com.amazonaws.billingconductor#PricingRuleArns", + "traits": { + "smithy.api#documentation": "

\n A list containing pricing rules associated with the requested pricing plan.\n

" + } + }, + "NextToken": { + "target": "com.amazonaws.billingconductor#Token", + "traits": { + "smithy.api#documentation": "

\n The pagination token to be used on subsequent calls.\n

" + } + } + } + }, + "com.amazonaws.billingconductor#ListPricingRulesFilter": { + "type": "structure", + "members": { + "Arns": { + "target": "com.amazonaws.billingconductor#PricingRuleArns", + "traits": { + "smithy.api#documentation": "

A list containing the pricing rule Amazon Resource Names (ARNs) to include in the API\n response.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The filter that specifies criteria that the pricing rules returned by the\n ListPricingRules API will adhere to.

" + } + }, + "com.amazonaws.billingconductor#ListPricingRulesInput": { + "type": "structure", + "members": { + "BillingPeriod": { + "target": "com.amazonaws.billingconductor#BillingPeriod", + "traits": { + "smithy.api#documentation": "

\n The preferred billing period to get the pricing plan.\n

" + } + }, + "Filters": { + "target": "com.amazonaws.billingconductor#ListPricingRulesFilter", + "traits": { + "smithy.api#documentation": "

A DescribePricingRuleFilter that specifies the Amazon Resource Name (ARNs)\n of pricing rules to retrieve pricing rules information.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.billingconductor#MaxPricingRuleResults", + "traits": { + "smithy.api#documentation": "

\n The maximum number of pricing rules to retrieve.\n

" + } + }, + "NextToken": { + "target": "com.amazonaws.billingconductor#Token", + "traits": { + "smithy.api#documentation": "

\n The pagination token used on subsequent call to get pricing rules.\n

" + } + } + } + }, + "com.amazonaws.billingconductor#ListPricingRulesOutput": { + "type": "structure", + "members": { + "BillingPeriod": { + "target": "com.amazonaws.billingconductor#BillingPeriod", + "traits": { + "smithy.api#documentation": "

\n The billing period for which the described pricing rules are applicable.\n

" + } + }, + "PricingRules": { + "target": "com.amazonaws.billingconductor#PricingRuleList", + "traits": { + "smithy.api#documentation": "

\n A list containing the described pricing rules.\n

" + } + }, + "NextToken": { + "target": "com.amazonaws.billingconductor#Token", + "traits": { + "smithy.api#documentation": "

\n The pagination token used on subsequent calls to get pricing rules.\n

" + } + } + } + }, + "com.amazonaws.billingconductor#ListResourcesAssociatedToCustomLineItem": { + "type": "operation", + "input": { + "target": "com.amazonaws.billingconductor#ListResourcesAssociatedToCustomLineItemInput" + }, + "output": { + "target": "com.amazonaws.billingconductor#ListResourcesAssociatedToCustomLineItemOutput" + }, + "errors": [ + { + "target": "com.amazonaws.billingconductor#AccessDeniedException" + }, + { + "target": "com.amazonaws.billingconductor#InternalServerException" + }, + { + "target": "com.amazonaws.billingconductor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.billingconductor#ThrottlingException" + }, + { + "target": "com.amazonaws.billingconductor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n List the resources associated to a custom line item.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/list-resources-associated-to-custom-line-item", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "AssociatedResources" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.billingconductor#ListResourcesAssociatedToCustomLineItemFilter": { + "type": "structure", + "members": { + "Relationship": { + "target": "com.amazonaws.billingconductor#CustomLineItemRelationship", + "traits": { + "smithy.api#documentation": "

\n The type of relationship between the custom line item and the associated resource.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n A filter that specifies the type of resource associations that should be retrieved for a custom line item.\n

" + } + }, + "com.amazonaws.billingconductor#ListResourcesAssociatedToCustomLineItemInput": { + "type": "structure", + "members": { + "BillingPeriod": { + "target": "com.amazonaws.billingconductor#BillingPeriod", + "traits": { + "smithy.api#documentation": "

\n The billing period for which the resource associations will be listed.\n

" + } + }, + "Arn": { + "target": "com.amazonaws.billingconductor#CustomLineItemArn", + "traits": { + "smithy.api#documentation": "

\n The ARN of the custom line item for which the resource associations will be listed.\n

", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.billingconductor#MaxCustomLineItemResults", + "traits": { + "smithy.api#documentation": "

\n (Optional) The maximum number of resource associations to be retrieved.\n

" + } + }, + "NextToken": { + "target": "com.amazonaws.billingconductor#Token", + "traits": { + "smithy.api#documentation": "

\n (Optional) The pagination token returned by a previous request.\n

" + } + }, + "Filters": { + "target": "com.amazonaws.billingconductor#ListResourcesAssociatedToCustomLineItemFilter", + "traits": { + "smithy.api#documentation": "

\n (Optional) A ListResourcesAssociatedToCustomLineItemFilter that can specify the types of resources that should be retrieved. \n

" + } + } + } + }, + "com.amazonaws.billingconductor#ListResourcesAssociatedToCustomLineItemOutput": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.billingconductor#CustomLineItemArn", + "traits": { + "smithy.api#documentation": "

\n The custom line item ARN for which the resource associations are listed.\n

" + } + }, + "AssociatedResources": { + "target": "com.amazonaws.billingconductor#ListResourcesAssociatedToCustomLineItemResponseList", + "traits": { + "smithy.api#documentation": "

\n A list of ListResourcesAssociatedToCustomLineItemResponseElement for each resource association retrieved.\n

" + } + }, + "NextToken": { + "target": "com.amazonaws.billingconductor#Token", + "traits": { + "smithy.api#documentation": "

\n The pagination token to be used in subsequent requests to retrieve additional results.\n

" + } + } + } + }, + "com.amazonaws.billingconductor#ListResourcesAssociatedToCustomLineItemResponseElement": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.billingconductor#CustomLineItemAssociationElement", + "traits": { + "smithy.api#documentation": "

\n The ARN of the associated resource.\n

" + } + }, + "Relationship": { + "target": "com.amazonaws.billingconductor#CustomLineItemRelationship", + "traits": { + "smithy.api#documentation": "

\n The type of relationship between the custom line item and the associated resource.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n A representation of a resource association for a custom line item.\n

" + } + }, + "com.amazonaws.billingconductor#ListResourcesAssociatedToCustomLineItemResponseList": { + "type": "list", + "member": { + "target": "com.amazonaws.billingconductor#ListResourcesAssociatedToCustomLineItemResponseElement" + } + }, + "com.amazonaws.billingconductor#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.billingconductor#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.billingconductor#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.billingconductor#AccessDeniedException" + }, + { + "target": "com.amazonaws.billingconductor#InternalServerException" + }, + { + "target": "com.amazonaws.billingconductor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.billingconductor#ThrottlingException" + }, + { + "target": "com.amazonaws.billingconductor#ValidationException" + } + ], + "traits": { + "aws.iam#conditionKeys": ["aws:TagKeys", "aws:RequestTag/${TagKey}"], + "smithy.api#documentation": "

\n A list the tags for a resource.\n

", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{ResourceArn}", + "code": 204 + } + } + }, + "com.amazonaws.billingconductor#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.billingconductor#Arn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) that identifies the resource to list the tags.\n

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#references": [ + { + "resource": "com.amazonaws.billingconductor#BillingGroup", + "ids": { + "Arn": "ResourceArn" + } + }, + { + "resource": "com.amazonaws.billingconductor#PricingPlan", + "ids": { + "Arn": "ResourceArn" + } + }, + { + "resource": "com.amazonaws.billingconductor#PricingRule", + "ids": { + "Arn": "ResourceArn" + } + }, + { + "resource": "com.amazonaws.billingconductor#CustomLineItem", + "ids": { + "Arn": "ResourceArn" + } + } + ] + } + }, + "com.amazonaws.billingconductor#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.billingconductor#TagMap", + "traits": { + "smithy.api#documentation": "

\n The tags for the resource.\n

" + } + } + } + }, + "com.amazonaws.billingconductor#Margin": { + "type": "string" + }, + "com.amazonaws.billingconductor#MarginPercentage": { + "type": "string" + }, + "com.amazonaws.billingconductor#MaxBillingGroupResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.billingconductor#MaxCustomLineItemResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.billingconductor#MaxPricingPlanResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.billingconductor#MaxPricingRuleResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.billingconductor#ModifierPercentage": { + "type": "double", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.billingconductor#NumberOfAccounts": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.billingconductor#NumberOfAssociatedPricingRules": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.billingconductor#NumberOfAssociations": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.billingconductor#NumberOfPricingPlansAssociatedWith": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.billingconductor#PricingPlan": { + "type": "resource", + "identifiers": { + "Arn": { + "target": "com.amazonaws.billingconductor#PricingPlanArn" + } + }, + "create": { + "target": "com.amazonaws.billingconductor#CreatePricingPlan" + }, + "update": { + "target": "com.amazonaws.billingconductor#UpdatePricingPlan" + }, + "delete": { + "target": "com.amazonaws.billingconductor#DeletePricingPlan" + }, + "list": { + "target": "com.amazonaws.billingconductor#ListPricingPlans" + }, + "operations": [ + { + "target": "com.amazonaws.billingconductor#AssociatePricingRules" + }, + { + "target": "com.amazonaws.billingconductor#DisassociatePricingRules" + } + ], + "collectionOperations": [ + { + "target": "com.amazonaws.billingconductor#ListPricingPlansAssociatedWithPricingRule" + } + ], + "traits": { + "aws.cloudformation#cfnResource": {}, + "aws.iam#conditionKeys": ["aws:ResourceTag/${TagKey}"], + "aws.iam#disableConditionKeyInference": {}, + "smithy.api#documentation": "Pricing Plan enables you to customize your billing\ndetails consistent with the usage that accrues\nin each of your billing groups.\n" + } + }, + "com.amazonaws.billingconductor#PricingPlanArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(arn:aws:billingconductor::[0-9]{12}:pricingplan/)?[a-zA-Z0-9]{10}$" + } + }, + "com.amazonaws.billingconductor#PricingPlanArns": { + "type": "list", + "member": { + "target": "com.amazonaws.billingconductor#PricingPlanArn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.billingconductor#PricingPlanDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.billingconductor#PricingPlanFullArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws:billingconductor::[0-9]{12}:pricingplan/[a-zA-Z0-9]{10}$" + } + }, + "com.amazonaws.billingconductor#PricingPlanList": { + "type": "list", + "member": { + "target": "com.amazonaws.billingconductor#PricingPlanListElement" + } + }, + "com.amazonaws.billingconductor#PricingPlanListElement": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.billingconductor#PricingPlanName", + "traits": { + "smithy.api#documentation": "

The name of a pricing plan.\n

" + } + }, + "Arn": { + "target": "com.amazonaws.billingconductor#PricingPlanArn", + "traits": { + "smithy.api#documentation": "

The pricing plan Amazon Resource Names (ARN). This can be used to uniquely identify a\n pricing plan.

" + } + }, + "Description": { + "target": "com.amazonaws.billingconductor#PricingPlanDescription", + "traits": { + "smithy.api#documentation": "

The pricing plan description.\n

" + } + }, + "Size": { + "target": "com.amazonaws.billingconductor#NumberOfAssociatedPricingRules", + "traits": { + "smithy.api#documentation": "

\n The pricing rules count currently associated with this pricing plan list element.\n

" + } + }, + "CreationTime": { + "target": "com.amazonaws.billingconductor#Instant", + "traits": { + "smithy.api#documentation": "

\n The time the pricing plan was created.\n

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.billingconductor#Instant", + "traits": { + "smithy.api#documentation": "

\n The most recent time the pricing plan was modified.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A representation of a pricing plan.\n

" + } + }, + "com.amazonaws.billingconductor#PricingPlanName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_\\+=\\.\\-@]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.billingconductor#PricingRule": { + "type": "resource", + "identifiers": { + "Arn": { + "target": "com.amazonaws.billingconductor#PricingRuleArn" + } + }, + "create": { + "target": "com.amazonaws.billingconductor#CreatePricingRule" + }, + "update": { + "target": "com.amazonaws.billingconductor#UpdatePricingRule" + }, + "delete": { + "target": "com.amazonaws.billingconductor#DeletePricingRule" + }, + "list": { + "target": "com.amazonaws.billingconductor#ListPricingRules" + }, + "collectionOperations": [ + { + "target": "com.amazonaws.billingconductor#ListPricingRulesAssociatedToPricingPlan" + } + ], + "traits": { + "aws.cloudformation#cfnResource": {}, + "aws.iam#conditionKeys": ["aws:ResourceTag/${TagKey}"], + "aws.iam#disableConditionKeyInference": {}, + "smithy.api#documentation": "A markup/discount that is defined for a specific set\nof services that can later be associated with a pricing plan.\n" + } + }, + "com.amazonaws.billingconductor#PricingRuleArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(arn:aws:billingconductor::[0-9]{12}:pricingrule/)?[a-zA-Z0-9]{10}$" + } + }, + "com.amazonaws.billingconductor#PricingRuleArns": { + "type": "list", + "member": { + "target": "com.amazonaws.billingconductor#PricingRuleArn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.billingconductor#PricingRuleArnsInput": { + "type": "list", + "member": { + "target": "com.amazonaws.billingconductor#PricingRuleArn" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 30 + } + } + }, + "com.amazonaws.billingconductor#PricingRuleArnsNonEmptyInput": { + "type": "list", + "member": { + "target": "com.amazonaws.billingconductor#PricingRuleArn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30 + } + } + }, + "com.amazonaws.billingconductor#PricingRuleDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.billingconductor#PricingRuleList": { + "type": "list", + "member": { + "target": "com.amazonaws.billingconductor#PricingRuleListElement" + } + }, + "com.amazonaws.billingconductor#PricingRuleListElement": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.billingconductor#PricingRuleName", + "traits": { + "smithy.api#documentation": "

\n The name of a pricing rule.\n

" + } + }, + "Arn": { + "target": "com.amazonaws.billingconductor#PricingRuleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) used to uniquely identify a pricing rule.

" + } + }, + "Description": { + "target": "com.amazonaws.billingconductor#PricingRuleDescription", + "traits": { + "smithy.api#documentation": "

\n The pricing rule description.\n

" + } + }, + "Scope": { + "target": "com.amazonaws.billingconductor#PricingRuleScope", + "traits": { + "smithy.api#documentation": "

\n The scope of pricing rule that indicates if it is globally applicable, or if it is service-specific.\n

" + } + }, + "Type": { + "target": "com.amazonaws.billingconductor#PricingRuleType", + "traits": { + "smithy.api#documentation": "

\n The type of pricing rule.\n

" + } + }, + "ModifierPercentage": { + "target": "com.amazonaws.billingconductor#ModifierPercentage", + "traits": { + "smithy.api#documentation": "

\n A percentage modifier applied on the public pricing rates.\n

" + } + }, + "Service": { + "target": "com.amazonaws.billingconductor#Service", + "traits": { + "smithy.api#documentation": "

\n If the Scope attribute is SERVICE, this attribute indicates which service the PricingRule is applicable for.\n

" + } + }, + "AssociatedPricingPlanCount": { + "target": "com.amazonaws.billingconductor#NumberOfPricingPlansAssociatedWith", + "traits": { + "smithy.api#documentation": "

\n The pricing plans count that this pricing rule is associated with.\n

" + } + }, + "CreationTime": { + "target": "com.amazonaws.billingconductor#Instant", + "traits": { + "smithy.api#documentation": "

\n The time the pricing rule was created.\n

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.billingconductor#Instant", + "traits": { + "smithy.api#documentation": "

\n The most recent time the pricing rule was modified.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n A representation of a pricing rule.\n

" + } + }, + "com.amazonaws.billingconductor#PricingRuleName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_\\+=\\.\\-@]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.billingconductor#PricingRuleScope": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "GLOBAL", + "name": "GLOBAL" + }, + { + "value": "SERVICE", + "name": "SERVICE" + } + ] + } + }, + "com.amazonaws.billingconductor#PricingRuleType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "MARKUP", + "name": "MARKUP" + }, + { + "value": "DISCOUNT", + "name": "DISCOUNT" + } + ] + } + }, + "com.amazonaws.billingconductor#ProformaCost": { + "type": "string" + }, + "com.amazonaws.billingconductor#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.billingconductor#String", + "traits": { + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.billingconductor#String", + "traits": { + "smithy.api#documentation": "

Resource identifier that was not found.\n

", + "smithy.api#required": {} + } + }, + "ResourceType": { + "target": "com.amazonaws.billingconductor#String", + "traits": { + "smithy.api#documentation": "

Resource type that was not found.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The request references a resource that doesn't exist.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.billingconductor#RetryAfterSeconds": { + "type": "integer" + }, + "com.amazonaws.billingconductor#Service": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]+$" + } + }, + "com.amazonaws.billingconductor#ServiceLimitExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.billingconductor#String", + "traits": { + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.billingconductor#String", + "traits": { + "smithy.api#documentation": "

Identifier of the resource affected.\n

" + } + }, + "ResourceType": { + "target": "com.amazonaws.billingconductor#String", + "traits": { + "smithy.api#documentation": "

Type of the resource affected.\n

" + } + }, + "LimitCode": { + "target": "com.amazonaws.billingconductor#String", + "traits": { + "smithy.api#documentation": "

The unique code identifier of the service limit that is being exceeded.\n

", + "smithy.api#required": {} + } + }, + "ServiceCode": { + "target": "com.amazonaws.billingconductor#String", + "traits": { + "smithy.api#documentation": "

The unique code for the service of the limit that is being exceeded.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The request would cause a service limit to exceed.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.billingconductor#String": { + "type": "string" + }, + "com.amazonaws.billingconductor#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.billingconductor#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.billingconductor#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.billingconductor#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.billingconductor#TagKey" + }, + "value": { + "target": "com.amazonaws.billingconductor#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.billingconductor#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.billingconductor#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.billingconductor#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.billingconductor#AccessDeniedException" + }, + { + "target": "com.amazonaws.billingconductor#InternalServerException" + }, + { + "target": "com.amazonaws.billingconductor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.billingconductor#ThrottlingException" + }, + { + "target": "com.amazonaws.billingconductor#ValidationException" + } + ], + "traits": { + "aws.iam#conditionKeys": ["aws:TagKeys", "aws:RequestTag/${TagKey}"], + "smithy.api#documentation": "

Associates the specified tags to a resource with the specified resourceArn.\n If existing tags on a resource are not specified in the request parameters, they are not\n changed.

", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{ResourceArn}", + "code": 204 + } + } + }, + "com.amazonaws.billingconductor#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.billingconductor#Arn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the resource to which to add tags.\n

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.billingconductor#TagMap", + "traits": { + "smithy.api#documentation": "

\n The tags to add to the resource as a list of key-value pairs.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "aws.api#data": "tagging", + "smithy.api#references": [ + { + "resource": "com.amazonaws.billingconductor#BillingGroup", + "ids": { + "Arn": "ResourceArn" + } + }, + { + "resource": "com.amazonaws.billingconductor#PricingPlan", + "ids": { + "Arn": "ResourceArn" + } + }, + { + "resource": "com.amazonaws.billingconductor#PricingRule", + "ids": { + "Arn": "ResourceArn" + } + }, + { + "resource": "com.amazonaws.billingconductor#CustomLineItem", + "ids": { + "Arn": "ResourceArn" + } + } + ] + } + }, + "com.amazonaws.billingconductor#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.billingconductor#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.billingconductor#ThrottlingException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.billingconductor#String", + "traits": { + "smithy.api#required": {} + } + }, + "RetryAfterSeconds": { + "target": "com.amazonaws.billingconductor#RetryAfterSeconds", + "traits": { + "smithy.api#documentation": "

Number of seconds you can safely retry after the call.\n

", + "smithy.api#httpHeader": "Retry-After" + } + } + }, + "traits": { + "smithy.api#documentation": "

The request was denied due to request throttling.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.billingconductor#Token": { + "type": "string" + }, + "com.amazonaws.billingconductor#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.billingconductor#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.billingconductor#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.billingconductor#AccessDeniedException" + }, + { + "target": "com.amazonaws.billingconductor#InternalServerException" + }, + { + "target": "com.amazonaws.billingconductor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.billingconductor#ThrottlingException" + }, + { + "target": "com.amazonaws.billingconductor#ValidationException" + } + ], + "traits": { + "aws.iam#conditionKeys": ["aws:TagKeys", "aws:RequestTag/${TagKey}"], + "smithy.api#documentation": "

\n Deletes specified tags from a resource.\n

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{ResourceArn}", + "code": 204 + } + } + }, + "com.amazonaws.billingconductor#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.billingconductor#Arn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the resource to which to delete tags.\n

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.billingconductor#TagKeyList", + "traits": { + "smithy.api#documentation": "

\n The tags to delete from the resource as a list of key-value pairs.\n

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "aws.api#data": "tagging", + "smithy.api#references": [ + { + "resource": "com.amazonaws.billingconductor#BillingGroup", + "ids": { + "Arn": "ResourceArn" + } + }, + { + "resource": "com.amazonaws.billingconductor#PricingPlan", + "ids": { + "Arn": "ResourceArn" + } + }, + { + "resource": "com.amazonaws.billingconductor#PricingRule", + "ids": { + "Arn": "ResourceArn" + } + }, + { + "resource": "com.amazonaws.billingconductor#CustomLineItem", + "ids": { + "Arn": "ResourceArn" + } + } + ] + } + }, + "com.amazonaws.billingconductor#UntagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.billingconductor#UpdateBillingGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.billingconductor#UpdateBillingGroupInput" + }, + "output": { + "target": "com.amazonaws.billingconductor#UpdateBillingGroupOutput" + }, + "errors": [ + { + "target": "com.amazonaws.billingconductor#AccessDeniedException" + }, + { + "target": "com.amazonaws.billingconductor#ConflictException" + }, + { + "target": "com.amazonaws.billingconductor#InternalServerException" + }, + { + "target": "com.amazonaws.billingconductor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.billingconductor#ThrottlingException" + }, + { + "target": "com.amazonaws.billingconductor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

This updates an existing billing group.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/update-billing-group", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.billingconductor#UpdateBillingGroupInput": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.billingconductor#BillingGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the billing group being updated.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.billingconductor#BillingGroupName", + "traits": { + "smithy.api#documentation": "

The name of the billing group. The names must be unique to each billing group.\n

" + } + }, + "Status": { + "target": "com.amazonaws.billingconductor#BillingGroupStatus", + "traits": { + "smithy.api#documentation": "

The status of the billing group. Only one of the valid values can be used.\n

" + } + }, + "ComputationPreference": { + "target": "com.amazonaws.billingconductor#ComputationPreference", + "traits": { + "smithy.api#documentation": "

\n The preferences and settings that will be used to compute the Amazon Web Services charges for a billing group.\n

" + } + }, + "Description": { + "target": "com.amazonaws.billingconductor#BillingGroupDescription", + "traits": { + "smithy.api#documentation": "

A description of the billing group. \n

" + } + } + } + }, + "com.amazonaws.billingconductor#UpdateBillingGroupOutput": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.billingconductor#BillingGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the billing group that was updated.

" + } + }, + "Name": { + "target": "com.amazonaws.billingconductor#BillingGroupName", + "traits": { + "smithy.api#documentation": "

\n The name of the billing group. The names must be unique to each billing group.\n

" + } + }, + "Description": { + "target": "com.amazonaws.billingconductor#BillingGroupDescription", + "traits": { + "smithy.api#documentation": "

\n A description of the billing group.\n

" + } + }, + "PrimaryAccountId": { + "target": "com.amazonaws.billingconductor#AccountId", + "traits": { + "smithy.api#documentation": "

\n The account ID that serves as the main account in a billing group.\n

" + } + }, + "PricingPlanArn": { + "target": "com.amazonaws.billingconductor#PricingPlanArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the pricing plan to compute Amazon Web Services charges for the\n billing group.\n

" + } + }, + "Size": { + "target": "com.amazonaws.billingconductor#NumberOfAccounts", + "traits": { + "smithy.api#documentation": "

\n The number of accounts in the particular billing group.\n

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.billingconductor#Instant", + "traits": { + "smithy.api#documentation": "

\n The most recent time the billing group was modified.\n

" + } + }, + "Status": { + "target": "com.amazonaws.billingconductor#BillingGroupStatus", + "traits": { + "smithy.api#documentation": "

\n The status of the billing group. Only one of the valid values can be used.\n

" + } + }, + "StatusReason": { + "target": "com.amazonaws.billingconductor#BillingGroupStatusReason", + "traits": { + "smithy.api#documentation": "

\n The reason why the billing group is in its current status.\n

" + } + } + } + }, + "com.amazonaws.billingconductor#UpdateCustomLineItem": { + "type": "operation", + "input": { + "target": "com.amazonaws.billingconductor#UpdateCustomLineItemInput" + }, + "output": { + "target": "com.amazonaws.billingconductor#UpdateCustomLineItemOutput" + }, + "errors": [ + { + "target": "com.amazonaws.billingconductor#AccessDeniedException" + }, + { + "target": "com.amazonaws.billingconductor#InternalServerException" + }, + { + "target": "com.amazonaws.billingconductor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.billingconductor#ThrottlingException" + }, + { + "target": "com.amazonaws.billingconductor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Update an existing custom line item in the current or previous billing period.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/update-custom-line-item", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.billingconductor#UpdateCustomLineItemChargeDetails": { + "type": "structure", + "members": { + "Flat": { + "target": "com.amazonaws.billingconductor#UpdateCustomLineItemFlatChargeDetails", + "traits": { + "smithy.api#documentation": "

\n An UpdateCustomLineItemFlatChargeDetails that describes the new charge details of a flat custom line item.\n

" + } + }, + "Percentage": { + "target": "com.amazonaws.billingconductor#UpdateCustomLineItemPercentageChargeDetails", + "traits": { + "smithy.api#documentation": "

\n An UpdateCustomLineItemPercentageChargeDetails that describes the new charge details of a percentage custom line item.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n A representation of the new charge details of a custom line item. This should contain only one of Flat or Percentage.\n

" + } + }, + "com.amazonaws.billingconductor#UpdateCustomLineItemFlatChargeDetails": { + "type": "structure", + "members": { + "ChargeValue": { + "target": "com.amazonaws.billingconductor#CustomLineItemChargeValue", + "traits": { + "smithy.api#documentation": "

\n The custom line item's new fixed charge value in USD.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

\n A representation of the new charge details associated with a flat custom line item.\n

" + } + }, + "com.amazonaws.billingconductor#UpdateCustomLineItemInput": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.billingconductor#CustomLineItemArn", + "traits": { + "smithy.api#documentation": "

\n The ARN of the custom line item to be updated.\n

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.billingconductor#BillingGroupName", + "traits": { + "smithy.api#documentation": "

\n The new name for the custom line item.\n

" + } + }, + "Description": { + "target": "com.amazonaws.billingconductor#CustomLineItemDescription", + "traits": { + "smithy.api#documentation": "

\n The new line item description of the custom line item.\n

" + } + }, + "ChargeDetails": { + "target": "com.amazonaws.billingconductor#UpdateCustomLineItemChargeDetails", + "traits": { + "smithy.api#documentation": "

\n A ListCustomLineItemChargeDetails containing the new charge details for the custom line item.\n

" + } + }, + "BillingPeriodRange": { + "target": "com.amazonaws.billingconductor#CustomLineItemBillingPeriodRange" + } + } + }, + "com.amazonaws.billingconductor#UpdateCustomLineItemOutput": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.billingconductor#CustomLineItemArn", + "traits": { + "smithy.api#documentation": "

\n The ARN of the successfully updated custom line item.\n

" + } + }, + "BillingGroupArn": { + "target": "com.amazonaws.billingconductor#BillingGroupFullArn", + "traits": { + "smithy.api#documentation": "

\n The ARN of the billing group that the custom line item is applied to.\n

" + } + }, + "Name": { + "target": "com.amazonaws.billingconductor#CustomLineItemName", + "traits": { + "smithy.api#documentation": "

\n The name of the successfully updated custom line item.\n

" + } + }, + "Description": { + "target": "com.amazonaws.billingconductor#CustomLineItemDescription", + "traits": { + "smithy.api#documentation": "

\n The description of the successfully updated custom line item.\n

" + } + }, + "ChargeDetails": { + "target": "com.amazonaws.billingconductor#ListCustomLineItemChargeDetails", + "traits": { + "smithy.api#documentation": "

\n A ListCustomLineItemChargeDetails containing the charge details of the successfully updated custom line item.\n

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.billingconductor#Instant", + "traits": { + "smithy.api#documentation": "

\n The most recent time the custom line item was modified.\n

" + } + }, + "AssociationSize": { + "target": "com.amazonaws.billingconductor#NumberOfAssociations", + "traits": { + "smithy.api#documentation": "

\n The number of resources that are associated to the custom line item.\n

" + } + } + } + }, + "com.amazonaws.billingconductor#UpdateCustomLineItemPercentageChargeDetails": { + "type": "structure", + "members": { + "PercentageValue": { + "target": "com.amazonaws.billingconductor#CustomLineItemPercentageChargeValue", + "traits": { + "smithy.api#documentation": "

\n The custom line item's new percentage value. This will be multiplied against the combined value of its associated resources to determine its charge value.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

\n A representation of the new charge details associated with a percentage custom line item.\n

" + } + }, + "com.amazonaws.billingconductor#UpdatePricingPlan": { + "type": "operation", + "input": { + "target": "com.amazonaws.billingconductor#UpdatePricingPlanInput" + }, + "output": { + "target": "com.amazonaws.billingconductor#UpdatePricingPlanOutput" + }, + "errors": [ + { + "target": "com.amazonaws.billingconductor#AccessDeniedException" + }, + { + "target": "com.amazonaws.billingconductor#ConflictException" + }, + { + "target": "com.amazonaws.billingconductor#InternalServerException" + }, + { + "target": "com.amazonaws.billingconductor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.billingconductor#ThrottlingException" + }, + { + "target": "com.amazonaws.billingconductor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

This updates an existing pricing plan.\n

", + "smithy.api#http": { + "method": "PUT", + "uri": "/update-pricing-plan", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.billingconductor#UpdatePricingPlanInput": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.billingconductor#PricingPlanArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the pricing plan you're updating.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.billingconductor#PricingPlanName", + "traits": { + "smithy.api#documentation": "

The name of the pricing plan. The name must be unique to each pricing plan.\n

" + } + }, + "Description": { + "target": "com.amazonaws.billingconductor#PricingPlanDescription", + "traits": { + "smithy.api#documentation": "

The pricing plan description.\n

" + } + } + } + }, + "com.amazonaws.billingconductor#UpdatePricingPlanOutput": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.billingconductor#PricingPlanArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the updated pricing plan.

" + } + }, + "Name": { + "target": "com.amazonaws.billingconductor#PricingPlanName", + "traits": { + "smithy.api#documentation": "

\n The name of the pricing plan. The name must be unique to each pricing plan.\n

" + } + }, + "Description": { + "target": "com.amazonaws.billingconductor#PricingPlanDescription", + "traits": { + "smithy.api#documentation": "

\n The new description for the pricing rule.\n

" + } + }, + "Size": { + "target": "com.amazonaws.billingconductor#NumberOfAssociatedPricingRules", + "traits": { + "smithy.api#documentation": "

\n The pricing rules count currently associated with this pricing plan list.\n

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.billingconductor#Instant", + "traits": { + "smithy.api#documentation": "

\n The most recent time the pricing plan was modified.\n

" + } + } + } + }, + "com.amazonaws.billingconductor#UpdatePricingRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.billingconductor#UpdatePricingRuleInput" + }, + "output": { + "target": "com.amazonaws.billingconductor#UpdatePricingRuleOutput" + }, + "errors": [ + { + "target": "com.amazonaws.billingconductor#AccessDeniedException" + }, + { + "target": "com.amazonaws.billingconductor#ConflictException" + }, + { + "target": "com.amazonaws.billingconductor#InternalServerException" + }, + { + "target": "com.amazonaws.billingconductor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.billingconductor#ThrottlingException" + }, + { + "target": "com.amazonaws.billingconductor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Updates an existing pricing rule.\n

", + "smithy.api#http": { + "method": "PUT", + "uri": "/update-pricing-rule", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.billingconductor#UpdatePricingRuleInput": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.billingconductor#PricingRuleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the pricing rule to update.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.billingconductor#PricingRuleName", + "traits": { + "smithy.api#documentation": "

\n The new name of the pricing rule. The name must be unique to each pricing rule.\n

" + } + }, + "Description": { + "target": "com.amazonaws.billingconductor#PricingRuleDescription", + "traits": { + "smithy.api#documentation": "

\n The new description for the pricing rule.\n

" + } + }, + "Type": { + "target": "com.amazonaws.billingconductor#PricingRuleType", + "traits": { + "smithy.api#documentation": "

\n The new pricing rule type.\n

" + } + }, + "ModifierPercentage": { + "target": "com.amazonaws.billingconductor#ModifierPercentage", + "traits": { + "smithy.api#documentation": "

\n The new modifier to show pricing plan rates as a percentage.\n

" + } + } + } + }, + "com.amazonaws.billingconductor#UpdatePricingRuleOutput": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.billingconductor#PricingRuleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the successfully updated pricing rule.

" + } + }, + "Name": { + "target": "com.amazonaws.billingconductor#PricingRuleName", + "traits": { + "smithy.api#documentation": "

\n The new name of the pricing rule. The name must be unique to each pricing rule.\n

" + } + }, + "Description": { + "target": "com.amazonaws.billingconductor#PricingRuleDescription", + "traits": { + "smithy.api#documentation": "

\n The new description for the pricing rule.\n

" + } + }, + "Scope": { + "target": "com.amazonaws.billingconductor#PricingRuleScope", + "traits": { + "smithy.api#documentation": "

\n The scope of pricing rule that indicates if it is globally applicable, or is service-specific.\n

" + } + }, + "Type": { + "target": "com.amazonaws.billingconductor#PricingRuleType", + "traits": { + "smithy.api#documentation": "

\n The new pricing rule type.\n

" + } + }, + "ModifierPercentage": { + "target": "com.amazonaws.billingconductor#ModifierPercentage", + "traits": { + "smithy.api#documentation": "

\n The new modifier to show pricing plan rates as a percentage.\n

" + } + }, + "Service": { + "target": "com.amazonaws.billingconductor#Service", + "traits": { + "smithy.api#documentation": "

\n If the Scope attribute is set to SERVICE, the attribute indicates which service the PricingRule is applicable for.\n

" + } + }, + "AssociatedPricingPlanCount": { + "target": "com.amazonaws.billingconductor#NumberOfPricingPlansAssociatedWith", + "traits": { + "smithy.api#documentation": "

\n The pricing plans count that this pricing rule is associated with.\n

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.billingconductor#Instant", + "traits": { + "smithy.api#documentation": "

\n The most recent time the pricing rule was modified.\n

" + } + } + } + }, + "com.amazonaws.billingconductor#ValidationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.billingconductor#String", + "traits": { + "smithy.api#required": {} + } + }, + "Reason": { + "target": "com.amazonaws.billingconductor#ValidationExceptionReason", + "traits": { + "smithy.api#documentation": "

The reason the request's validation failed.\n

" + } + }, + "Fields": { + "target": "com.amazonaws.billingconductor#ValidationExceptionFieldList", + "traits": { + "smithy.api#documentation": "

The fields that caused the error, if applicable.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The input doesn't match with the constraints specified by Amazon Web Services services.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.billingconductor#ValidationExceptionField": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.billingconductor#String", + "traits": { + "smithy.api#documentation": "

The field name.\n

", + "smithy.api#required": {} + } + }, + "Message": { + "target": "com.amazonaws.billingconductor#String", + "traits": { + "smithy.api#documentation": "

The message describing why the field failed validation.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The field's information of a request that resulted in an exception.\n

" + } + }, + "com.amazonaws.billingconductor#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.billingconductor#ValidationExceptionField" + } + }, + "com.amazonaws.billingconductor#ValidationExceptionReason": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "UNKNOWN_OPERATION", + "name": "UNKNOWN_OPERATION" + }, + { + "value": "CANNOT_PARSE", + "name": "CANNOT_PARSE" + }, + { + "value": "FIELD_VALIDATION_FAILED", + "name": "FIELD_VALIDATION_FAILED" + }, + { + "value": "OTHER", + "name": "OTHER" + }, + { + "value": "PRIMARY_NOT_ASSOCIATED", + "name": "PRIMARY_NOT_ASSOCIATED" + }, + { + "value": "PRIMARY_CANNOT_DISASSOCIATE", + "name": "PRIMARY_CANNOT_DISASSOCIATE" + }, + { + "value": "ACCOUNTS_NOT_ASSOCIATED", + "name": "ACCOUNTS_NOT_ASSOCIATED" + }, + { + "value": "ACCOUNTS_ALREADY_ASSOCIATED", + "name": "ACCOUNTS_ALREADY_ASSOCIATED" + }, + { + "value": "ILLEGAL_PRIMARY_ACCOUNT", + "name": "ILLEGAL_PRIMARY_ACCOUNT" + }, + { + "value": "ILLEGAL_ACCOUNTS", + "name": "ILLEGAL_ACCOUNTS" + }, + { + "value": "MISMATCHED_BILLINGGROUP_ARN", + "name": "MISMATCHED_BILLINGGROUP_ARN" + }, + { + "value": "MISSING_BILLINGGROUP", + "name": "MISSING_BILLINGGROUP" + }, + { + "value": "MISMATCHED_CUSTOMLINEITEM_ARN", + "name": "MISMATCHED_CUSTOMLINEITEM_ARN" + }, + { + "value": "ILLEGAL_BILLING_PERIOD", + "name": "ILLEGAL_BILLING_PERIOD" + }, + { + "value": "ILLEGAL_BILLING_PERIOD_RANGE", + "name": "ILLEGAL_BILLING_PERIOD_RANGE" + }, + { + "value": "TOO_MANY_ACCOUNTS_IN_REQUEST", + "name": "TOO_MANY_ACCOUNTS_IN_REQUEST" + }, + { + "value": "DUPLICATE_ACCOUNT", + "name": "DUPLICATE_ACCOUNT" + }, + { + "value": "INVALID_BILLING_GROUP_STATUS", + "name": "INVALID_BILLING_GROUP_STATUS" + }, + { + "value": "MISMATCHED_PRICINGPLAN_ARN", + "name": "MISMATCHED_PRICINGPLAN_ARN" + }, + { + "value": "MISSING_PRICINGPLAN", + "name": "MISSING_PRICINGPLAN" + }, + { + "value": "MISMATCHED_PRICINGRULE_ARN", + "name": "MISMATCHED_PRICINGRULE_ARN" + }, + { + "value": "DUPLICATE_PRICINGRULE_ARNS", + "name": "DUPLICATE_PRICINGRULE_ARNS" + }, + { + "value": "ILLEGAL_EXPRESSION", + "name": "ILLEGAL_EXPRESSION" + }, + { + "value": "ILLEGAL_SCOPE", + "name": "ILLEGAL_SCOPE" + }, + { + "value": "ILLEGAL_SERVICE", + "name": "ILLEGAL_SERVICE" + }, + { + "value": "PRICINGRULES_NOT_EXIST", + "name": "PRICINGRULES_NOT_EXIST" + }, + { + "value": "PRICINGRULES_ALREADY_ASSOCIATED", + "name": "PRICINGRULES_ALREADY_ASSOCIATED" + }, + { + "value": "PRICINGRULES_NOT_ASSOCIATED", + "name": "PRICINGRULES_NOT_ASSOCIATED" + }, + { + "value": "INVALID_TIME_RANGE", + "name": "INVALID_TIME_RANGE" + }, + { + "value": "INVALID_BILLINGVIEW_ARN", + "name": "INVALID_BILLINGVIEW_ARN" + }, + { + "value": "MISMATCHED_BILLINGVIEW_ARN", + "name": "MISMATCHED_BILLINGVIEW_ARN" + }, + { + "value": "ILLEGAL_CUSTOMLINEITEM", + "name": "ILLEGAL_CUSTOMLINEITEM" + }, + { + "value": "MISSING_CUSTOMLINEITEM", + "name": "MISSING_CUSTOMLINEITEM" + }, + { + "value": "ILLEGAL_CUSTOMLINEITEM_UPDATE", + "name": "ILLEGAL_CUSTOMLINEITEM_UPDATE" + }, + { + "value": "TOO_MANY_CUSTOMLINEITEMS_IN_REQUEST", + "name": "TOO_MANY_CUSTOMLINEITEMS_IN_REQUEST" + }, + { + "value": "ILLEGAL_CHARGE_DETAILS", + "name": "ILLEGAL_CHARGE_DETAILS" + }, + { + "value": "ILLEGAL_UPDATE_CHARGE_DETAILS", + "name": "ILLEGAL_UPDATE_CHARGE_DETAILS" + }, + { + "value": "INVALID_ARN", + "name": "INVALID_ARN" + }, + { + "value": "ILLEGAL_RESOURCE_ARNS", + "name": "ILLEGAL_RESOURCE_ARNS" + }, + { + "value": "ILLEGAL_CUSTOMLINEITEM_MODIFICATION", + "name": "ILLEGAL_CUSTOMLINEITEM_MODIFICATION" + }, + { + "value": "MISSING_LINKED_ACCOUNT_IDS", + "name": "MISSING_LINKED_ACCOUNT_IDS" + }, + { + "value": "MULTIPLE_LINKED_ACCOUNT_IDS", + "name": "MULTIPLE_LINKED_ACCOUNT_IDS" + }, + { + "value": "MISSING_PRICING_PLAN_ARN", + "name": "MISSING_PRICING_PLAN_ARN" + }, + { + "value": "MULTIPLE_PRICING_PLAN_ARN", + "name": "MULTIPLE_PRICING_PLAN_ARN" + } + ] + } + } + } +} diff --git a/codegen/sdk-codegen/aws-models/chime-sdk-meetings.json b/codegen/sdk-codegen/aws-models/chime-sdk-meetings.json index 0a787f996fad2..b381bc8aafab7 100644 --- a/codegen/sdk-codegen/aws-models/chime-sdk-meetings.json +++ b/codegen/sdk-codegen/aws-models/chime-sdk-meetings.json @@ -453,6 +453,12 @@ "traits": { "smithy.api#documentation": "

Lists the audio and video features enabled for a meeting, such as echo reduction.

" } + }, + "PrimaryMeetingId": { + "target": "com.amazonaws.chimesdkmeetings#PrimaryMeetingId", + "traits": { + "smithy.api#documentation": "

When specified, replicates the media from the primary meeting to the new meeting.

" + } } } }, @@ -547,6 +553,12 @@ "smithy.api#documentation": "

The attendee information, including attendees' IDs and join tokens.

", "smithy.api#required": {} } + }, + "PrimaryMeetingId": { + "target": "com.amazonaws.chimesdkmeetings#PrimaryMeetingId", + "traits": { + "smithy.api#documentation": "

When specified, replicates the media from the primary meeting to the new meeting.

" + } } } }, @@ -1174,6 +1186,12 @@ "traits": { "smithy.api#documentation": "

The features available to a meeting, such as Amazon Voice Focus.

" } + }, + "PrimaryMeetingId": { + "target": "com.amazonaws.chimesdkmeetings#PrimaryMeetingId", + "traits": { + "smithy.api#documentation": "

When specified, replicates the media from the primary meeting to this meeting.

" + } } }, "traits": { @@ -1257,6 +1275,15 @@ "smithy.api#documentation": "

The configuration for resource targets to receive notifications when meeting and attendee events occur.

" } }, + "com.amazonaws.chimesdkmeetings#PrimaryMeetingId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 64 + } + } + }, "com.amazonaws.chimesdkmeetings#ResultMax": { "type": "integer", "traits": { diff --git a/codegen/sdk-codegen/aws-models/chime.json b/codegen/sdk-codegen/aws-models/chime.json index 8402dca883230..22c6acdf9aaa7 100644 --- a/codegen/sdk-codegen/aws-models/chime.json +++ b/codegen/sdk-codegen/aws-models/chime.json @@ -2680,7 +2680,7 @@ "Tags": { "target": "com.amazonaws.chime#TagList", "traits": { - "smithy.api#documentation": "

Tags assigned to the AppInstanceUser.

" + "smithy.api#documentation": "

Tags assigned to the AppInstance.

" } } } @@ -3550,6 +3550,9 @@ "target": "com.amazonaws.chime#CreateMeetingDialOutResponse" }, "errors": [ + { + "target": "com.amazonaws.chime#AccessDeniedException" + }, { "target": "com.amazonaws.chime#BadRequestException" }, @@ -7369,7 +7372,7 @@ "ContentIdentificationType": { "target": "com.amazonaws.chime#TranscribeContentIdentificationType", "traits": { - "smithy.api#documentation": "

Set this field to PII to identify personal health information in the transcription output.

" + "smithy.api#documentation": "

Set this field to PII to identify personally identifiable information in the transcription output.

" } }, "ContentRedactionType": { @@ -12552,7 +12555,13 @@ "EnableSIPLogs": { "target": "com.amazonaws.chime#Boolean", "traits": { - "smithy.api#documentation": "

When true, enables SIP message logs for sending to Amazon CloudWatch Logs.

" + "smithy.api#documentation": "

Boolean that enables SIP message logs to CloudWatch logs.

" + } + }, + "EnableMediaMetricLogs": { + "target": "com.amazonaws.chime#Boolean", + "traits": { + "smithy.api#documentation": "

Boolean that enables logging of detailed media metrics for Voice Connectors to CloudWatch logs.

" } } }, @@ -12800,7 +12809,7 @@ "EventIngestionUrl": { "target": "com.amazonaws.chime#UriType", "traits": { - "smithy.api#documentation": "

The event ingestion URL.

" + "smithy.api#documentation": "

The event ingestion URL to which you send client meeting events.

" } } }, @@ -18989,7 +18998,7 @@ } ], "traits": { - "smithy.api#documentation": "

Allows you to trigger a Lambda function at any time while a call is active, and replace the current actions with new actions returned by the invocation.

", + "smithy.api#documentation": "

Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an update request. The Lambda function can then return a new set of actions.

", "smithy.api#http": { "method": "POST", "uri": "/sip-media-applications/{SipMediaApplicationId}/calls/{TransactionId}", diff --git a/codegen/sdk-codegen/aws-models/cognito-identity-provider.json b/codegen/sdk-codegen/aws-models/cognito-identity-provider.json index 92db8ffbf8dbd..0f84b04b7add8 100644 --- a/codegen/sdk-codegen/aws-models/cognito-identity-provider.json +++ b/codegen/sdk-codegen/aws-models/cognito-identity-provider.json @@ -399,7 +399,7 @@ "EventAction": { "target": "com.amazonaws.cognitoidentityprovider#AccountTakeoverEventActionType", "traits": { - "smithy.api#documentation": "

The event action.

\n \n ", + "smithy.api#documentation": "

The action to take in response to the account takeover action. Valid values\n are:

\n \n ", "smithy.api#required": {} } } @@ -661,7 +661,7 @@ "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { - "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

\n

If your user pool configuration includes triggers, the AdminConfirmSignUp API action invokes the Lambda function that is specified \n for the post confirmation trigger. When Amazon Cognito invokes this function, it passes a \n JSON \n payload, which the function receives as input. In this payload, the clientMetadata attribute provides the data that you assigned \n to the ClientMetadata parameter in your AdminConfirmSignUp request. In your function code in Lambda, you can process the ClientMetadata value \n to enhance your workflow for your specific needs.

\n

For more information, see Customizing User Pool Workflows \n with Lambda Triggers in the Amazon Cognito Developer Guide.

\n \n \n

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

\n \n " + "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

\n

If your user pool configuration includes triggers, the AdminConfirmSignUp API action\n invokes the Lambda function that is specified for the post\n confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON\n payload, which the function receives as input. In this payload, the\n clientMetadata attribute provides the data that you assigned to the\n ClientMetadata parameter in your AdminConfirmSignUp request. In your function code in\n Lambda, you can process the ClientMetadata value to enhance your workflow for your\n specific needs.

\n\n

For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

\n\n \n

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

\n \n " } } }, @@ -735,7 +735,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new user in the specified user pool.

\n

If MessageAction isn't set, the default is to send a welcome message via email or phone (SMS).

\n \n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an \n origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must \n register a phone number with Amazon Pinpoint. Amazon Cognito will use the registered number \n automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, \n or sign in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service \n might place your account in SMS sandbox. In \n \n sandbox mode\n , you will have \n limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move \n out of the SMS sandbox and into production. For more information, see \n SMS \n message settings for Amazon Cognito User Pools in the Amazon Cognito Developer Guide.

\n \n \n

This message is based on a template that you configured in your call to create or update a user pool. This template includes your custom sign-up instructions and placeholders for \n user name and temporary password.

\n

Alternatively, you can call AdminCreateUser with SUPPRESS for the MessageAction parameter, and Amazon Cognito won't send any email.

\n

In either case, the user will be in the FORCE_CHANGE_PASSWORD state until they sign in and change their password.

\n

\n AdminCreateUser requires developer credentials.

" + "smithy.api#documentation": "

Creates a new user in the specified user pool.

\n

If MessageAction isn't set, the default is to send a welcome message via email or phone (SMS).

\n \n \n\n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n \n\n

This message is based on a template that you configured in your call to create or update a user pool. This template includes your custom sign-up instructions and placeholders for \n user name and temporary password.

\n

Alternatively, you can call AdminCreateUser with SUPPRESS for the MessageAction parameter, and Amazon Cognito won't send any email.

\n

In either case, the user will be in the FORCE_CHANGE_PASSWORD state until they sign in and change their password.

\n

\n AdminCreateUser requires developer credentials.

" } }, "com.amazonaws.cognitoidentityprovider#AdminCreateUserConfigType": { @@ -820,7 +820,7 @@ "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { - "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

\n

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminCreateUser API action, \n Amazon Cognito invokes the function that is assigned to the pre sign-up trigger. When Amazon Cognito invokes this function, \n it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, \n which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code \n in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

\n

For more information, \n see Customizing User Pool Workflows with Lambda Triggers \n in the Amazon Cognito Developer Guide.

\n \n

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

\n \n " + "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

\n

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminCreateUser API action, \n Amazon Cognito invokes the function that is assigned to the pre sign-up trigger. When Amazon Cognito invokes this function, \n it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, \n which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code \n in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

\n\n

For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

\n\n \n

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

\n \n " } } }, @@ -1002,7 +1002,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disables the user from signing in with the specified external (SAML or social) identity provider. If the user to disable is a Amazon Cognito User Pools native username + password user, \n they aren't permitted to use their password to sign in. If the user to deactivate is a linked external identity provider (IdP) user, any link between that user and an existing \n user is removed. The next time the external user (no longer attached to the previously linked DestinationUser) signs in, they must create a new user account. \n See AdminLinkProviderForUser.

\n

This action is enabled only for admin access and requires developer credentials.

\n

The ProviderName must match the value specified when creating an IdP for the pool.

\n

To deactivate a native username + password user, the ProviderName value must be Cognito and the ProviderAttributeName must be Cognito_Subject. \n The ProviderAttributeValue must be the name that is used in the user pool for the user.

\n

The ProviderAttributeName must always be Cognito_Subject for social identity providers. The ProviderAttributeValue must always be the exact \n subject that was used when the user was originally linked as a source user.

\n

For de-linking a SAML identity, there are two scenarios. If the linked identity has not yet been used to sign in, the ProviderAttributeName and ProviderAttributeValue \n must be the same values that were used for the SourceUser when the identities were originally linked using AdminLinkProviderForUser call. (If the linking was done \n with ProviderAttributeName set to Cognito_Subject, the same applies here). However, if the user has already signed in, the ProviderAttributeName must \n be Cognito_Subject and ProviderAttributeValue must be the subject of the SAML assertion.

" + "smithy.api#documentation": "

Prevents the user from signing in with the specified external (SAML or social)\n identity provider. If the user that you want to deactivate is a Amazon Cognito user pools native\n username + password user, they can't use their password to sign in. If the user to\n deactivate is a linked external identity provider (IdP) user, any link between that user\n and an existing user is removed. When the external user signs in again, and the user is\n no longer attached to the previously linked DestinationUser, the user must\n create a new user account. See AdminLinkProviderForUser.

\n

This action is enabled only for admin access and requires developer credentials.

\n

The ProviderName must match the value specified when creating an IdP for the pool.

\n

To deactivate a native username + password user, the ProviderName value must be Cognito and the ProviderAttributeName must be Cognito_Subject. \n The ProviderAttributeValue must be the name that is used in the user pool for the user.

\n

The ProviderAttributeName must always be Cognito_Subject for social identity providers. The ProviderAttributeValue must always be the exact \n subject that was used when the user was originally linked as a source user.

\n

For de-linking a SAML identity, there are two scenarios. If the linked identity has not yet been used to sign in, the ProviderAttributeName and ProviderAttributeValue \n must be the same values that were used for the SourceUser when the identities were originally linked using AdminLinkProviderForUser call. (If the linking was done \n with ProviderAttributeName set to Cognito_Subject, the same applies here). However, if the user has already signed in, the ProviderAttributeName must \n be Cognito_Subject and ProviderAttributeValue must be the subject of the SAML assertion.

" } }, "com.amazonaws.cognitoidentityprovider#AdminDisableProviderForUserRequest": { @@ -1378,7 +1378,7 @@ "UserStatus": { "target": "com.amazonaws.cognitoidentityprovider#UserStatusType", "traits": { - "smithy.api#documentation": "

The user status. Can be one of the following:

\n " + "smithy.api#documentation": "

The user status. Can be one of the following:

\n " } }, "MFAOptions": { @@ -1460,7 +1460,7 @@ } ], "traits": { - "smithy.api#documentation": "

Initiates the authentication flow, as an administrator.

\n \n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an \n origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must \n register a phone number with Amazon Pinpoint. Amazon Cognito will use the registered number \n automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, \n or sign in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service \n might place your account in SMS sandbox. In \n \n sandbox mode\n , you will have \n limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move \n out of the SMS sandbox and into production. For more information, see \n SMS \n message settings for Amazon Cognito User Pools in the Amazon Cognito Developer Guide.

\n \n \n

Calling this action requires developer credentials.

" + "smithy.api#documentation": "

Initiates the authentication flow, as an administrator.

\n\n\n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n \n\n

Calling this action requires developer credentials.

" } }, "com.amazonaws.cognitoidentityprovider#AdminInitiateAuthRequest": { @@ -1496,7 +1496,7 @@ "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { - "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.

\n

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminInitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for \n various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:

\n \n

When Amazon Cognito invokes the functions for these triggers, it passes a JSON \n payload, which the function receives as input. This payload contains a validationData attribute, which provides the data that you assigned to the \n ClientMetadata parameter in your AdminInitiateAuth request. In your function code in Lambda, you can process the validationData value to enhance \n your workflow for your specific needs.

\n

When you use the AdminInitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn't provide the ClientMetadata value as input:

\n \n

For more information, see Customizing User Pool Workflows with \n Lambda Triggers in the Amazon Cognito Developer Guide.

\n \n \n

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

\n \n " + "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.

\n

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminInitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for \n various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:

\n \n

When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which\n the function receives as input. This payload contains a validationData\n attribute, which provides the data that you assigned to the ClientMetadata parameter in\n your AdminInitiateAuth request. In your function code in Lambda, you can process the\n validationData value to enhance your workflow for your specific\n needs.

\n

When you use the AdminInitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn't provide the ClientMetadata value as input:

\n \n\n

For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

\n\n \n

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

\n \n " } }, "AnalyticsMetadata": { @@ -1599,7 +1599,7 @@ "DestinationUser": { "target": "com.amazonaws.cognitoidentityprovider#ProviderUserIdentifierType", "traits": { - "smithy.api#documentation": "

The existing user in the user pool to be linked to the external identity provider user account. Can be a native (Username + Password) Amazon Cognito User Pools user or a federated user \n (for example, a SAML or Facebook user). If the user doesn't exist, an exception is thrown. This is the user that is returned when the new user (with the linked identity provider \n attribute) signs in.

\n

For a native username + password user, the ProviderAttributeValue for the DestinationUser should be the username in the user pool. For a federated user, \n it should be the provider-specific user_id.

\n

The ProviderAttributeName of the DestinationUser is ignored.

\n

The ProviderName should be set to Cognito for users in Cognito user pools.

\n \n

All attributes in the DestinationUser profile must be mutable. If you have assigned the user any immutable custom attributes, the operation won't succeed.

\n ", + "smithy.api#documentation": "

The existing user in the user pool that you want to assign to the external identity\n provider user account. This user can be a native (Username + Password) Amazon Cognito user pools\n user or a federated user (for example, a SAML or Facebook user). If the user doesn't\n exist, Amazon Cognito generates an exception. Amazon Cognito returns this user when the new user (with the\n linked identity provider attribute) signs in.

\n

For a native username + password user, the ProviderAttributeValue for the DestinationUser should be the username in the user pool. For a federated user, \n it should be the provider-specific user_id.

\n

The ProviderAttributeName of the DestinationUser is ignored.

\n

The ProviderName should be set to Cognito for users in Cognito user pools.

\n \n

All attributes in the DestinationUser profile must be mutable. If you have assigned the user any immutable custom attributes, the operation won't succeed.

\n ", "smithy.api#required": {} } }, @@ -1982,7 +1982,7 @@ } ], "traits": { - "smithy.api#documentation": "

Resets the specified user's password in a user pool as an administrator. Works on any user.

\n

When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, \n the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same \n as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if \n email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user \n with the code to change their password.

\n \n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an \n origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must \n register a phone number with Amazon Pinpoint. Amazon Cognito will use the registered number \n automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, \n or sign in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service \n might place your account in SMS sandbox. In \n \n sandbox mode\n , you will have \n limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move \n out of the SMS sandbox and into production. For more information, see \n SMS \n message settings for Amazon Cognito User Pools in the Amazon Cognito Developer Guide.

\n \n \n

Calling this action requires developer credentials.

" + "smithy.api#documentation": "

Resets the specified user's password in a user pool as an administrator. Works on any user.

\n

When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, \n the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same \n as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if \n email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user \n with the code to change their password.

\n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n \n\n

Calling this action requires developer credentials.

" } }, "com.amazonaws.cognitoidentityprovider#AdminResetUserPasswordRequest": { @@ -2005,7 +2005,7 @@ "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { - "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

\n \n

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminResetUserPassword API action, \n Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, \n which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the \n ClientMetadata parameter in your AdminResetUserPassword request. In your function code in Lambda, you can process the clientMetadata \n value to enhance your workflow for your specific needs.\n

\n

For more information, see Customizing User Pool \n Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

\n \n \n

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

\n \n " + "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

\n \n

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminResetUserPassword API action, \n Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, \n which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the \n ClientMetadata parameter in your AdminResetUserPassword request. In your function code in Lambda, you can process the clientMetadata \n value to enhance your workflow for your specific needs.\n

\n\n

For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

\n\n \n

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

\n \n " } } }, @@ -2091,7 +2091,7 @@ } ], "traits": { - "smithy.api#documentation": "

Responds to an authentication challenge, as an administrator.

\n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an \n origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must \n register a phone number with Amazon Pinpoint. Amazon Cognito will use the registered number \n automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, \n or sign in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service \n might place your account in SMS sandbox. In \n \n sandbox mode\n , you will have \n limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move \n out of the SMS sandbox and into production. For more information, see \n SMS \n message settings for Amazon Cognito User Pools in the Amazon Cognito Developer Guide.

\n \n \n

Calling this action requires developer credentials.

" + "smithy.api#documentation": "

Responds to an authentication challenge, as an administrator.

\n\n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n \n\n

Calling this action requires developer credentials.

" } }, "com.amazonaws.cognitoidentityprovider#AdminRespondToAuthChallengeRequest": { @@ -2145,7 +2145,7 @@ "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { - "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

\n

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminRespondToAuthChallenge API action, Amazon Cognito\n invokes any functions that are assigned to the \n following triggers: pre sign-up, custom message, post authentication, \n user migration, pre token generation, define auth challenge, create auth \n challenge, and verify auth challenge response. When Amazon Cognito invokes any of these functions, it passes a JSON \n payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned \n to the ClientMetadata parameter in your AdminRespondToAuthChallenge request. In your function code in Lambda, you can process the \n clientMetadata value to enhance your workflow for your specific needs.

\n

For more information, see Customizing User Pool Workflows with \n Lambda Triggers in the Amazon Cognito Developer Guide.

\n \n \n

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

\n \n " + "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

\n

You create custom workflows by assigning Lambda functions to user pool triggers.\n When you use the AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions\n that you have assigned to the following triggers:

\n \n

When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the\n function receives as input. This payload contains a clientMetadata\n attribute that provides the data that you assigned to the ClientMetadata parameter in\n your AdminRespondToAuthChallenge request. In your function code in Lambda, you can\n process the clientMetadata value to enhance your workflow for your specific\n needs.

\n\n

For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

\n\n \n

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

\n \n " } } }, @@ -2590,7 +2590,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.

\n

For custom attributes, you must prepend the custom: prefix to the attribute name.

\n

In addition to updating user attributes, this API can also be used to mark phone and email as verified.

\n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an \n origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must \n register a phone number with Amazon Pinpoint. Amazon Cognito will use the registered number \n automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, \n or sign in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service \n might place your account in SMS sandbox. In \n \n sandbox mode\n , you will have \n limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move \n out of the SMS sandbox and into production. For more information, see \n SMS \n message settings for Amazon Cognito User Pools in the Amazon Cognito Developer Guide.

\n \n \n

Calling this action requires developer credentials.

" + "smithy.api#documentation": "

Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.

\n

For custom attributes, you must prepend the custom: prefix to the attribute name.

\n

In addition to updating user attributes, this API can also be used to mark phone and email as verified.

\n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n \n\n

Calling this action requires developer credentials.

" } }, "com.amazonaws.cognitoidentityprovider#AdminUpdateUserAttributesRequest": { @@ -2620,7 +2620,7 @@ "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { - "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

\n \n

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminUpdateUserAttributes API action, Amazon Cognito invokes \n the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives \n as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your \n AdminUpdateUserAttributes request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for \n your specific needs.

\n

For more information, \n see Customizing User Pool Workflows with Lambda Triggers \n in the Amazon Cognito Developer Guide.

\n \n \n

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

\n \n " + "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

\n \n

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminUpdateUserAttributes API action, Amazon Cognito invokes \n the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives \n as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your \n AdminUpdateUserAttributes request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for \n your specific needs.

\n\n

For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

\n\n \n

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

\n \n " } } }, @@ -2768,7 +2768,7 @@ "ApplicationArn": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint project for integration with the chosen User Pool Client. Amazon Cognito publishes events to the Amazon Pinpointproject \n declared by the app ARN.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint project\n to integrate with the chosen user pool Client. Amazon Cognito publishes events to the\n Amazon Pinpointproject declared by the app ARN.

" } }, "RoleArn": { @@ -2791,7 +2791,7 @@ } }, "traits": { - "smithy.api#documentation": "

The Amazon Pinpoint analytics configuration for collecting metrics for a user pool.

\n \n

In Regions where Pinpoint isn't available, User Pools only supports sending events to Amazon Pinpoint projects in us-east-1. In Regions where Pinpoint is available, User Pools will support \n sending events to Amazon Pinpoint projects within that same Region.

\n " + "smithy.api#documentation": "

The Amazon Pinpoint analytics configuration for collecting metrics for a user pool.

\n \n

In Regions where Amazon Pinpointisn't available, user pools only support sending events to Amazon Pinpoint\n projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support\n sending events to Amazon Pinpoint projects within that same Region.

\n " } }, "com.amazonaws.cognitoidentityprovider#AnalyticsMetadataType": { @@ -2805,7 +2805,7 @@ } }, "traits": { - "smithy.api#documentation": "

An Amazon Pinpoint analytics endpoint.

\n

An endpoint uniquely identifies a mobile device, email address, or phone number that can receive messages from Amazon Pinpoint analytics.

\n \n

Amazon Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the Region in which the user pool resides.

\n " + "smithy.api#documentation": "

An Amazon Pinpoint analytics endpoint.

\n

An endpoint uniquely identifies a mobile device, email address, or phone number that can receive messages from Amazon Pinpoint analytics.

\n \n

Amazon Cognito user pools only support sending events to Amazon Pinpoint projects in the US East (N.\n Virginia) us-east-1 Region, regardless of the Region where the user pool\n resides.

\n " } }, "com.amazonaws.cognitoidentityprovider#ArnType": { @@ -3139,7 +3139,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 20 + "max": 200 } } }, @@ -3775,7 +3775,7 @@ "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { - "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

\n

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ConfirmForgotPassword API action, Amazon Cognito \n invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a \n JSON payload, \n which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned \n to the ClientMetadata parameter in your ConfirmForgotPassword request. In your function code in Lambda, you can process the \n clientMetadata value to enhance your workflow for your specific needs.

\n

For more information, \n see Customizing User Pool Workflows with Lambda Triggers \n in the Amazon Cognito Developer Guide.

\n \n \n

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

\n \n " + "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

\n

You create custom workflows by assigning Lambda functions to user pool triggers.\n When you use the ConfirmForgotPassword API action, Amazon Cognito invokes the function that is\n assigned to the post confirmation trigger. When Amazon Cognito invokes this\n function, it passes a JSON payload, which the function receives as input. This payload\n contains a clientMetadata attribute, which provides the data that you\n assigned to the ClientMetadata parameter in your ConfirmForgotPassword request. In your\n function code in Lambda, you can process the clientMetadata value to\n enhance your workflow for your specific needs.

\n\n

For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

\n\n \n

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

\n \n " } } }, @@ -3899,7 +3899,7 @@ "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { - "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

\n \n

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ConfirmSignUp API action, \n Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this \n function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which \n provides the data that you assigned to the ClientMetadata parameter in your ConfirmSignUp request. In your function code in Lambda, \n you can process the clientMetadata value to enhance your workflow for your specific needs.

\n

For more information, \n see Customizing User Pool Workflows with Lambda Triggers \n in the Amazon Cognito Developer Guide.

\n \n \n

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

\n \n " + "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

\n \n

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ConfirmSignUp API action, \n Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this \n function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which \n provides the data that you assigned to the ClientMetadata parameter in your ConfirmSignUp request. In your function code in Lambda, \n you can process the clientMetadata value to enhance your workflow for your specific needs.

\n\n

For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

\n\n \n

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

\n \n " } } }, @@ -4333,7 +4333,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new Amazon Cognito user pool and sets the password policy for the pool.

\n \n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an \n origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must \n register a phone number with Amazon Pinpoint. Amazon Cognito will use the registered number \n automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, \n or sign in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service \n might place your account in SMS sandbox. In \n \n sandbox mode\n , you will have \n limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move \n out of the SMS sandbox and into production. For more information, see \n SMS \n message settings for Amazon Cognito User Pools in the Amazon Cognito Developer Guide.

\n " + "smithy.api#documentation": "

Creates a new Amazon Cognito user pool and sets the password policy for the pool.

\n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n " } }, "com.amazonaws.cognitoidentityprovider#CreateUserPoolClient": { @@ -4430,13 +4430,13 @@ "WriteAttributes": { "target": "com.amazonaws.cognitoidentityprovider#ClientPermissionListType", "traits": { - "smithy.api#documentation": "

The user pool attributes that the app client can write to.

\n

If your app client allows users to sign in through an identity provider, this array must include all attributes that are mapped to identity \n provider attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If your app client \n lacks write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see \n Specifying Identity \n Provider Attribute Mappings for Your User Pool.

" + "smithy.api#documentation": "

The user pool attributes that the app client can write to.

\n

If your app client allows users to sign in through an identity provider, this array\n must include all attributes that you have mapped to identity provider attributes. Amazon Cognito\n updates mapped attributes when users sign in to your application through an identity\n provider. If your app client does not have write access to a mapped attribute, Amazon Cognito\n throws an error when it tries to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your user\n pool.

" } }, "ExplicitAuthFlows": { "target": "com.amazonaws.cognitoidentityprovider#ExplicitAuthFlowsListType", "traits": { - "smithy.api#documentation": "

The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are no longer supported, \n in favor of new names with the ALLOW_ prefix. \n Note that values with ALLOW_ prefix must be used only along with the ALLOW_ prefix.

\n

Valid values include:

\n \n " + "smithy.api#documentation": "

The authentication flows that are supported by the user pool clients. Flow names\n without the ALLOW_ prefix are no longer supported, in favor of new names\n with the ALLOW_ prefix.

\n \n

Values with ALLOW_ prefix must be used only along with the\n ALLOW_ prefix.

\n \n

Valid values include:

\n \n " } }, "SupportedIdentityProviders": { @@ -4484,7 +4484,7 @@ "AnalyticsConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#AnalyticsConfigurationType", "traits": { - "smithy.api#documentation": "

The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.

\n \n

In Amazon Web Services Regions where isn't available, User Pools only supports sending events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where is available, User Pools will support \n sending events to Amazon Pinpoint projects within that same Region.

\n " + "smithy.api#documentation": "

The user pool analytics configuration for collecting metrics and sending them to your\n Amazon Pinpoint campaign.

\n \n

In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending\n events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is\n available, user pools support sending events to Amazon Pinpoint projects within that same\n Region.

\n " } }, "PreventUserExistenceErrors": { @@ -4668,13 +4668,13 @@ "EmailConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#EmailConfigurationType", "traits": { - "smithy.api#documentation": "

The email configuration.

" + "smithy.api#documentation": "

The email configuration of your user pool. The email configuration type sets your\n preferred sending method, Amazon Web Services Region, and sender for messages from your user\n pool.

" } }, "SmsConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#SmsConfigurationType", "traits": { - "smithy.api#documentation": "

The SMS configuration.

" + "smithy.api#documentation": "

The SMS configuration with the settings that your Amazon Cognito user pool must use to send an\n SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages\n with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management\n (IAM) role in your Amazon Web Services account.

" } }, "UserPoolTags": { @@ -4760,7 +4760,7 @@ "CertificateArn": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Certificate Manager SSL certificate. You use\n this certificate for the subdomain of your custom domain.

", "smithy.api#required": {} } } @@ -5950,7 +5950,7 @@ "SourceArn": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { - "smithy.api#documentation": "

The ARN of a verified email address in Amazon SES. Amazon Cognito uses this email address in one of the following ways, depending on the value that you specify for the EmailSendingAccount \n parameter:

\n " + "smithy.api#documentation": "

The ARN of a verified email address in Amazon SES. Amazon Cognito uses this email address in one of the following ways, depending on the value that you specify for the EmailSendingAccount \n parameter:

\n \n

The Region value of the SourceArn parameter must indicate a supported\n Amazon Web Services Region of your user pool. Typically, the Region in the SourceArn and\n the user pool Region are the same. For more information, see Amazon SES email configuration regions in the Amazon Cognito Developer\n Guide.

" } }, "ReplyToEmailAddress": { @@ -5962,7 +5962,7 @@ "EmailSendingAccount": { "target": "com.amazonaws.cognitoidentityprovider#EmailSendingAccountType", "traits": { - "smithy.api#documentation": "

Specifies whether Amazon Cognito emails your users by using its built-in email functionality or your Amazon Simple Email Service email configuration. Specify one of the following values:

\n
\n
COGNITO_DEFAULT
\n
\n

When Amazon Cognito emails your users, it uses its built-in email functionality. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool. \n For typical production environments, the default email limit is less than the required delivery volume. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email \n configuration.

\n

To look up the email delivery limit for the default option, see Limits in in the \n Developer Guide.

\n

The default FROM address is no-reply@verificationemail.com. To customize the FROM address, provide the Amazon Resource Name (ARN) of an Amazon SES verified email address \n for the SourceArn parameter.

\n

If EmailSendingAccount is COGNITO_DEFAULT, you can't use the following parameters:

\n
    \n
  • \n

    EmailVerificationMessage

    \n
    • \n
  • \n

    EmailVerificationSubject

    \n
    • \n
  • \n

    InviteMessageTemplate.EmailMessage

    \n
    • \n
  • \n

    InviteMessageTemplate.EmailSubject

    \n
    • \n
  • \n

    VerificationMessageTemplate.EmailMessage

    \n
    • \n
  • \n

    VerificationMessageTemplate.EmailMessageByLink

    \n
    • \n
  • \n

    VerificationMessageTemplate.EmailSubject,

    \n
    • \n
  • \n

    VerificationMessageTemplate.EmailSubjectByLink

    \n
    • \n
\n \n

DEVELOPER EmailSendingAccount is required.

\n \n
\n
DEVELOPER
\n
\n

When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address. When you use this \n option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your Amazon Web Services account.

\n

If you use this option, you must provide the ARN of an Amazon SES verified email address for the SourceArn parameter.

\n

Before Amazon Cognito can email your users, it requires additional permissions to call\n Amazon SES on your behalf. When you update your user pool with this option, Amazon Cognito\n creates a service-linked role, which is a type of role,\n in your Amazon Web Services account. This role contains the permissions that\n allow to access Amazon SES and send email messages with your address. For more\n information about the service-linked role that Amazon Cognito creates, see Using Service-Linked Roles for Amazon Cognito in the\n Amazon Cognito Developer Guide.

\n
\n
" + "smithy.api#documentation": "

Specifies whether Amazon Cognito uses its built-in functionality to send your users email\n messages, or uses your Amazon Simple Email Service email configuration. Specify one of the following\n values:

\n
\n
COGNITO_DEFAULT
\n
\n

When Amazon Cognito emails your users, it uses its built-in email functionality. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool. \n For typical production environments, the default email limit is less than the required delivery volume. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email \n configuration.

\n

To look up the email delivery limit for the default option, see Limits in in the \n Developer Guide.

\n

The default FROM address is no-reply@verificationemail.com. To customize the FROM address, provide the Amazon Resource Name (ARN) of an Amazon SES verified email address \n for the SourceArn parameter.

\n

If EmailSendingAccount is COGNITO_DEFAULT, you can't use the following parameters:

\n
    \n
  • \n

    EmailVerificationMessage

    \n
    • \n
  • \n

    EmailVerificationSubject

    \n
    • \n
  • \n

    InviteMessageTemplate.EmailMessage

    \n
    • \n
  • \n

    InviteMessageTemplate.EmailSubject

    \n
    • \n
  • \n

    VerificationMessageTemplate.EmailMessage

    \n
    • \n
  • \n

    VerificationMessageTemplate.EmailMessageByLink

    \n
    • \n
  • \n

    VerificationMessageTemplate.EmailSubject,

    \n
    • \n
  • \n

    VerificationMessageTemplate.EmailSubjectByLink

    \n
    • \n
\n \n

DEVELOPER EmailSendingAccount is required.

\n \n
\n
DEVELOPER
\n
\n

When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address. When you use this \n option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your Amazon Web Services account.

\n

If you use this option, you must provide the ARN of an Amazon SES verified email address for the SourceArn parameter.

\n

Before Amazon Cognito can email your users, it requires additional permissions to call\n Amazon SES on your behalf. When you update your user pool with this option, Amazon Cognito\n creates a service-linked role, which is a type of role,\n in your Amazon Web Services account. This role contains the permissions that\n allow to access Amazon SES and send email messages with your address. For more\n information about the service-linked role that Amazon Cognito creates, see Using Service-Linked Roles for Amazon Cognito in the\n Amazon Cognito Developer Guide.

\n
\n
" } }, "From": { @@ -5974,12 +5974,12 @@ "ConfigurationSet": { "target": "com.amazonaws.cognitoidentityprovider#SESConfigurationSet", "traits": { - "smithy.api#documentation": "

The set of configuration rules that can be applied to emails sent using Amazon Simple Email Service. A configuration set is applied to an email by including a reference to the configuration \n set in the headers of the email. Once applied, all of the rules in that configuration set are applied to the email. Configuration sets can be used to apply the following \n types of rules to emails:

\n \n " + "smithy.api#documentation": "

The set of configuration rules that can be applied to emails sent using Amazon Simple Email Service. A\n configuration set is applied to an email by including a reference to the configuration\n set in the headers of the email. Once applied, all of the rules in that configuration\n set are applied to the email. Configuration sets can be used to apply the following\n types of rules to emails:

\n
\n
Event publishing
\n
\n

Amazon Simple Email Service can track the number of send, delivery, open, click, bounce, and\n complaint events for each email sent. Use event publishing to send\n information about these events to other Amazon Web Services services such as and\n Amazon CloudWatch

\n
\n
IP pool management
\n
\n

When leasing dedicated IP addresses with Amazon Simple Email Service, you can create groups\n of IP addresses, called dedicated IP pools. You can then associate the\n dedicated IP pools with configuration sets.

\n
\n
" } } }, "traits": { - "smithy.api#documentation": "

The email configuration type.

\n \n

Amazon Cognito has specific Regions for use with Amazon Simple Email Service. For more information on the supported Regions, see Email \n settings for Amazon Cognito user pools.

\n " + "smithy.api#documentation": "

The email configuration of your user pool. The email configuration type sets your\n preferred sending method, Amazon Web Services Region, and sender for messages from your user\n pool.

\n \n

Amazon Cognito can send email messages with Amazon Simple Email Service resources in the Amazon Web Services Region where you\n created your user pool, and in alternate Regions in some cases. For more information\n on the supported Regions, see Email settings for Amazon Cognito user pools.

\n " } }, "com.amazonaws.cognitoidentityprovider#EmailNotificationBodyType": { @@ -6417,16 +6417,13 @@ { "target": "com.amazonaws.cognitoidentityprovider#UserLambdaValidationException" }, - { - "target": "com.amazonaws.cognitoidentityprovider#UserNotConfirmedException" - }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" } ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "

Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password. For the \n Username parameter, you can use the username or user alias. The method used to send the confirmation code is sent according to the \n specified AccountRecoverySetting. For more information, \n see Recovering User Accounts \n in the Amazon Cognito Developer Guide. If neither a verified phone number nor a verified email exists, \n an InvalidParameterException is thrown. To use the confirmation code for resetting the password, \n call ConfirmForgotPassword.\n

\n \n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an \n origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must \n register a phone number with Amazon Pinpoint. Amazon Cognito will use the registered number \n automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, \n or sign in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service \n might place your account in SMS sandbox. In \n \n sandbox mode\n , you will have \n limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move \n out of the SMS sandbox and into production. For more information, see \n SMS \n message settings for Amazon Cognito User Pools in the Amazon Cognito Developer Guide.

\n ", + "smithy.api#documentation": "

Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password. For the \n Username parameter, you can use the username or user alias. The method used to send the confirmation code is sent according to the \n specified AccountRecoverySetting. For more information, \n see Recovering User Accounts \n in the Amazon Cognito Developer Guide. If neither a verified phone number nor a verified email exists, \n an InvalidParameterException is thrown. To use the confirmation code for resetting the password, \n call ConfirmForgotPassword.\n

\n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n ", "smithy.api#optionalAuth": {} } }, @@ -6462,13 +6459,13 @@ "AnalyticsMetadata": { "target": "com.amazonaws.cognitoidentityprovider#AnalyticsMetadataType", "traits": { - "smithy.api#documentation": "

The Amazon Pinpoint analytics metadata for collecting metrics for ForgotPassword calls.

" + "smithy.api#documentation": "

The Amazon Pinpoint analytics metadata for collecting metrics for ForgotPassword\n calls.

" } }, "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { - "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

\n

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ForgotPassword API action, \n Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, \n and user migration. When Amazon Cognito invokes any of these functions, it passes a JSON \n payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned \n to the ClientMetadata parameter in your ForgotPassword request. In your function code in Lambda, you can process the \n clientMetadata value to enhance your workflow for your specific needs.

\n

For more information, see Customizing User Pool Workflows \n with Lambda Triggers in the Amazon Cognito Developer Guide.

\n \n \n

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

\n \n " + "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

\n

You create custom workflows by assigning Lambda functions to user pool\n triggers. When you use the ForgotPassword API action, Amazon Cognito invokes any\n functions that are assigned to the following triggers: pre sign-up,\n custom message, and user migration. When\n Amazon Cognito invokes any of these functions, it passes a JSON payload, which the\n function receives as input. This payload contains a clientMetadata\n attribute, which provides the data that you assigned to the ClientMetadata parameter in\n your ForgotPassword request. In your function code in Lambda, you can\n process the clientMetadata value to enhance your workflow for your specific\n needs.

\n\n

For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

\n\n \n

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

\n \n " } } }, @@ -6964,7 +6961,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "

Gets the user attribute verification code for the specified attribute name.

\n \n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an \n origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must \n register a phone number with Amazon Pinpoint. Amazon Cognito will use the registered number \n automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, \n or sign in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service \n might place your account in SMS sandbox. In \n \n sandbox mode\n , you will have \n limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move \n out of the SMS sandbox and into production. For more information, see \n SMS \n message settings for Amazon Cognito User Pools in the Amazon Cognito Developer Guide.

\n ", + "smithy.api#documentation": "

Gets the user attribute verification code for the specified attribute name.

\n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n ", "smithy.api#optionalAuth": {} } }, @@ -6988,7 +6985,7 @@ "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { - "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

\n \n

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the GetUserAttributeVerificationCode \n API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it \n passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data \n that you assigned to the ClientMetadata parameter in your GetUserAttributeVerificationCode request. In your function code in Lambda, \n you can process the clientMetadata value to enhance your workflow for your specific needs.

\n

For more information, \n see Customizing User Pool Workflows with Lambda Triggers \n in the Amazon Cognito Developer Guide.

\n \n \n

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

\n \n " + "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

\n \n

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the GetUserAttributeVerificationCode \n API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it \n passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data \n that you assigned to the ClientMetadata parameter in your GetUserAttributeVerificationCode request. In your function code in Lambda, \n you can process the clientMetadata value to enhance your workflow for your specific needs.

\n\n

For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

\n\n \n

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

\n \n " } } }, @@ -7476,7 +7473,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "

Initiates the authentication flow.

\n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an \n origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must \n register a phone number with Amazon Pinpoint. Amazon Cognito will use the registered number \n automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, \n or sign in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service \n might place your account in SMS sandbox. In \n \n sandbox mode\n , you will have \n limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move \n out of the SMS sandbox and into production. For more information, see \n SMS \n message settings for Amazon Cognito User Pools in the Amazon Cognito Developer Guide.

\n ", + "smithy.api#documentation": "

Initiates the authentication flow.

\n\n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n ", "smithy.api#optionalAuth": {} } }, @@ -7499,7 +7496,7 @@ "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { - "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.

\n

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the InitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various \n triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:

\n \n

When Amazon Cognito invokes the functions for these triggers, it passes a JSON \n payload, which the function receives as input. This payload contains a validationData attribute, which provides the data that you assigned to the ClientMetadata parameter in your \n InitiateAuth request. In your function code in Lambda, you can process the validationData value to enhance your workflow for your specific needs.

\n

When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn't provide the ClientMetadata value as input:

\n \n

For more information, see Customizing User Pool Workflows with \n Lambda Triggers in the Amazon Cognito Developer Guide.

\n \n \n

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

\n \n " + "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.

\n

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the InitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various \n triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:

\n \n

When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which\n the function receives as input. This payload contains a validationData\n attribute, which provides the data that you assigned to the ClientMetadata parameter in\n your InitiateAuth request. In your function code in Lambda, you can process the\n validationData value to enhance your workflow for your specific\n needs.

\n

When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn't provide the ClientMetadata value as input:

\n \n\n

For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

\n\n \n \n

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

\n \n " } }, "ClientId": { @@ -7532,7 +7529,7 @@ "ChallengeName": { "target": "com.amazonaws.cognitoidentityprovider#ChallengeNameType", "traits": { - "smithy.api#documentation": "

The name of the challenge that you're responding to with this call. This name is returned in the AdminInitiateAuth response if you must pass another challenge.

\n

Valid values include the following. Note that all of these challenges require \n USERNAME and SECRET_HASH (if applicable) in the parameters.

\n \n " + "smithy.api#documentation": "

The name of the challenge that you're responding to with this call. This name is\n returned in the AdminInitiateAuth response if you must pass another\n challenge.

\n

Valid values include the following:

\n \n

All of the following challenges require USERNAME and\n SECRET_HASH (if applicable) in the parameters.

\n \n \n " } }, "Session": { @@ -8661,7 +8658,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n This data type is no longer supported. You can use it \n only for SMS multi-factor authentication (MFA) configurations. You can't use it for time-based one-time password (TOTP) software token MFA configurations.

" + "smithy.api#documentation": "

\n This data type is no longer supported. Applies only to SMS\n multi-factor authentication (MFA) configurations. Does not apply to time-based one-time\n password (TOTP) software token MFA configurations.

" } }, "com.amazonaws.cognitoidentityprovider#MessageActionType": { @@ -8958,7 +8955,7 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 6, + "min": 0, "max": 256 }, "smithy.api#pattern": "^[\\S]+$", @@ -9222,6 +9219,15 @@ } } }, + "com.amazonaws.cognitoidentityprovider#RegionCodeType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 5, + "max": 32 + } + } + }, "com.amazonaws.cognitoidentityprovider#ResendConfirmationCode": { "type": "operation", "input": { @@ -9276,7 +9282,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "

Resends the confirmation (for confirmation of registration) to a specific user in the user pool.

\n \n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an \n origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must \n register a phone number with Amazon Pinpoint. Amazon Cognito will use the registered number \n automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, \n or sign in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service \n might place your account in SMS sandbox. In \n \n sandbox mode\n , you will have \n limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move \n out of the SMS sandbox and into production. For more information, see \n SMS \n message settings for Amazon Cognito User Pools in the Amazon Cognito Developer Guide.

\n ", + "smithy.api#documentation": "

Resends the confirmation (for confirmation of registration) to a specific user in the user pool.

\n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n ", "smithy.api#optionalAuth": {} } }, @@ -9318,7 +9324,7 @@ "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { - "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

\n

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ResendConfirmationCode API action, Amazon Cognito \n invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a \n JSON \n payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned \n to the ClientMetadata parameter in your ResendConfirmationCode request. In your function code in Lambda, you can process the clientMetadata \n value to enhance your workflow for your specific needs.

\n

For more information, \n see Customizing User Pool Workflows with Lambda Triggers \n in the Amazon Cognito Developer Guide.

\n \n \n

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

\n \n " + "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

\n

You create custom workflows by assigning Lambda functions to user pool triggers.\n When you use the ResendConfirmationCode API action, Amazon Cognito invokes the function that is\n assigned to the custom message trigger. When Amazon Cognito invokes this\n function, it passes a JSON payload, which the function receives as input. This payload\n contains a clientMetadata attribute, which provides the data that you\n assigned to the ClientMetadata parameter in your ResendConfirmationCode request. In your\n function code in Lambda, you can process the clientMetadata value to enhance\n your workflow for your specific needs.

\n\n

For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

\n\n \n

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

\n \n " } } }, @@ -9539,7 +9545,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "

Responds to the authentication challenge.

\n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an \n origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must \n register a phone number with Amazon Pinpoint. Amazon Cognito will use the registered number \n automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, \n or sign in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service \n might place your account in SMS sandbox. In \n \n sandbox mode\n , you will have \n limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move \n out of the SMS sandbox and into production. For more information, see \n SMS \n message settings for Amazon Cognito User Pools in the Amazon Cognito Developer Guide.

\n ", + "smithy.api#documentation": "

Responds to the authentication challenge.

\n\n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n ", "smithy.api#optionalAuth": {} } }, @@ -9587,7 +9593,7 @@ "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { - "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

\n

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the RespondToAuthChallenge API action, Amazon Cognito \n invokes any functions that are assigned to the following triggers: post authentication, pre token generation, \n define auth challenge, create auth challenge, and verify auth challenge. When Amazon Cognito \n invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata \n attribute, which provides the data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge request. In your function code in \n Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

\n

For more information, see Customizing \n User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

\n \n \n

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

\n \n " + "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

\n

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the RespondToAuthChallenge API action, Amazon Cognito \n invokes any functions that are assigned to the following triggers: post authentication, pre token generation, \n define auth challenge, create auth challenge, and verify auth challenge. When Amazon Cognito \n invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata \n attribute, which provides the data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge request. In your function code in \n Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

\n\n

For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

\n\n \n

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

\n \n " } } }, @@ -10227,7 +10233,7 @@ } ], "traits": { - "smithy.api#documentation": "

Sets the user pool multi-factor authentication (MFA) configuration.

\n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an \n origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must \n register a phone number with Amazon Pinpoint. Amazon Cognito will use the registered number \n automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, \n or sign in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service \n might place your account in SMS sandbox. In \n \n sandbox mode\n , you will have \n limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move \n out of the SMS sandbox and into production. For more information, see \n SMS \n message settings for Amazon Cognito User Pools in the Amazon Cognito Developer Guide.

\n " + "smithy.api#documentation": "

Sets the user pool multi-factor authentication (MFA) configuration.

\n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n " } }, "com.amazonaws.cognitoidentityprovider#SetUserPoolMfaConfigRequest": { @@ -10255,7 +10261,7 @@ "MfaConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolMfaType", "traits": { - "smithy.api#documentation": "

The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users with an MFA factor set up can sign in. To learn more, \n see Adding Multi-Factor Authentication (MFA) to a User Pool. Valid values include:

\n \n " + "smithy.api#documentation": "

The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who\n have set up an MFA factor can sign in. To learn more, see Adding Multi-Factor\n Authentication (MFA) to a user pool. Valid values include:

\n \n " } } } @@ -10403,7 +10409,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "

Registers the user in the specified user pool and creates a user name, password, and user attributes.

\n \n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an \n origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must \n register a phone number with Amazon Pinpoint. Amazon Cognito will use the registered number \n automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, \n or sign in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service \n might place your account in SMS sandbox. In \n \n sandbox mode\n , you will have \n limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move \n out of the SMS sandbox and into production. For more information, see \n SMS \n message settings for Amazon Cognito User Pools in the Amazon Cognito Developer Guide.

\n ", + "smithy.api#documentation": "

Registers the user in the specified user pool and creates a user name, password, and user attributes.

\n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n ", "smithy.api#optionalAuth": {} } }, @@ -10464,7 +10470,7 @@ "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { - "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

\n

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the SignUp API action, Amazon Cognito \n invokes any functions that are assigned to the following triggers: pre sign-up, custom message, \n and post confirmation. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function \n receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the \n ClientMetadata parameter in your SignUp request. In your function code in Lambda, you can process the clientMetadata \n value to enhance your workflow for your specific needs.

\n

For more information, \n see Customizing User Pool Workflows with Lambda Triggers \n in the Amazon Cognito Developer Guide.

\n \n \n

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

\n \n " + "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

\n

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the SignUp API action, Amazon Cognito \n invokes any functions that are assigned to the following triggers: pre sign-up, custom message, \n and post confirmation. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function \n receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the \n ClientMetadata parameter in your SignUp request. In your function code in Lambda, you can process the clientMetadata \n value to enhance your workflow for your specific needs.

\n\n

For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

\n\n \n

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

\n \n " } } }, @@ -10508,7 +10514,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 20 + "max": 200 } } }, @@ -10525,12 +10531,18 @@ "ExternalId": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "

The external ID is a value that you should use to add security to your IAM role that is used to call Amazon SNS to send SMS messages for your user pool. If you provide an ExternalId, \n the Amazon Cognito User Pool will include it when attempting to assume your IAM role so that you can set your roles trust policy to require the ExternalID. If you use the Amazon Cognito Management \n Console to create a role for SMS multi-factor authentication (MFA), Amazon Cognito will create a role with the required permissions and a trust policy that demonstrates use of the ExternalId.

\n

For more information about the ExternalId of a role, \n see How to use an external ID when granting access to your Amazon Web Services resources to a \n third party\n

" + "smithy.api#documentation": "

The external ID provides additional security for your IAM role. You can use an\n ExternalId with the IAM role that you use with Amazon SNS to send SMS\n messages for your user pool. If you provide an ExternalId, your Amazon Cognito user\n pool includes it in the request to assume your IAM role. You can configure the role\n trust policy to require that Amazon Cognito, and any principal, provide the\n ExternalID. If you use the Amazon Cognito Management Console to create a role\n for SMS multi-factor authentication (MFA), Amazon Cognito creates a role with the required\n permissions and a trust policy that demonstrates use of the\n ExternalId.

\n

For more information about the ExternalId of a role, \n see How to use an external ID when granting access to your Amazon Web Services resources to a \n third party\n

" + } + }, + "SnsRegion": { + "target": "com.amazonaws.cognitoidentityprovider#RegionCodeType", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region to use with Amazon SNS integration. You can choose the same Region as your\n user pool, or a supported Legacy Amazon SNS alternate\n Region.

\n

\n Amazon Cognito resources in the Asia Pacific (Seoul) Amazon Web Services Region must use your Amazon SNS\n configuration in the Asia Pacific (Tokyo) Region. For more information, see SMS message settings for Amazon Cognito user pools.

" } } }, "traits": { - "smithy.api#documentation": "

The SMS configuration type that includes the settings the Amazon Cognito User Pool must call for the Amazon Simple Notification Service service to send an SMS message from your Amazon Web Services account. The \n Amazon Cognito User Pool makes the request to the Amazon SNS Service by using an Identity and Access Management role that you provide for your Amazon Web Services account.

" + "smithy.api#documentation": "

The SMS configuration type is the settings that your Amazon Cognito user pool must use to send\n an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS\n messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an\n Identity and Access Management (IAM) role in your Amazon Web Services account.

" } }, "com.amazonaws.cognitoidentityprovider#SmsMfaConfigType": { @@ -10545,7 +10557,7 @@ "SmsConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#SmsConfigurationType", "traits": { - "smithy.api#documentation": "

The SMS configuration.

" + "smithy.api#documentation": "

The SMS configuration with the settings that your Amazon Cognito user pool must use to send an\n SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To request Amazon SNS in\n the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role that\n you provide for your Amazon Web Services account.

" } } }, @@ -11096,7 +11108,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request failed because the user is in an unsupported\n state.

", + "smithy.api#documentation": "

The request failed because the user is in an unsupported state.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -11605,7 +11617,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "

Allows a user to update a specific attribute (one at a time).

\n \n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an \n origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must \n register a phone number with Amazon Pinpoint. Amazon Cognito will use the registered number \n automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, \n or sign in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service \n might place your account in SMS sandbox. In \n \n sandbox mode\n , you will have \n limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move \n out of the SMS sandbox and into production. For more information, see \n SMS \n message settings for Amazon Cognito User Pools in the Amazon Cognito Developer Guide.

\n ", + "smithy.api#documentation": "

Allows a user to update a specific attribute (one at a time).

\n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n ", "smithy.api#optionalAuth": {} } }, @@ -11629,7 +11641,7 @@ "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { - "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for any custom workflows that this action initiates.

\n

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the UpdateUserAttributes API action, Amazon Cognito invokes the \n function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a \n JSON \n payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you \n assigned to the ClientMetadata parameter in your UpdateUserAttributes request. In your function code in Lambda, you can process the clientMetadata \n value to enhance your workflow for your specific needs.

\n

For more information, see Customizing User Pool \n Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

\n \n \n

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

\n \n " + "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for any custom workflows that this action initiates.

\n

You create custom workflows by assigning Lambda functions to user pool triggers. When\n you use the UpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned\n to the custom message trigger. When Amazon Cognito invokes this function, it\n passes a JSON payload, which the function receives as input. This payload contains a\n clientMetadata attribute, which provides the data that you assigned to\n the ClientMetadata parameter in your UpdateUserAttributes request. In your function code\n in Lambda, you can process the clientMetadata value to enhance your workflow\n for your specific needs.

\n\n

For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

\n\n \n

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

\n \n " } } }, @@ -11695,7 +11707,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the specified user pool with the specified attributes. You can get a list of the current user pool settings using \n DescribeUserPool. \n If you don't provide a value for an attribute, it will be set to the default value.

\n \n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an \n origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must \n register a phone number with Amazon Pinpoint. Amazon Cognito will use the registered number \n automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, \n or sign in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service \n might place your account in SMS sandbox. In \n \n sandbox mode\n , you will have \n limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move \n out of the SMS sandbox and into production. For more information, see \n SMS \n message settings for Amazon Cognito User Pools in the Amazon Cognito Developer Guide.

\n " + "smithy.api#documentation": "

Updates the specified user pool with the specified attributes. You can get a list of the current user pool settings using \n DescribeUserPool. \n If you don't provide a value for an attribute, it will be set to the default value.

\n\n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n " } }, "com.amazonaws.cognitoidentityprovider#UpdateUserPoolClient": { @@ -11846,7 +11858,7 @@ "AnalyticsConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#AnalyticsConfigurationType", "traits": { - "smithy.api#documentation": "

The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.

\n \n

In Amazon Web Services Regions where isn't available, User Pools only supports sending events to Amazon Pinpoint projects in us-east-1. In Regions where Pinpoint is available, User Pools will support \n sending events to Amazon Pinpoint projects within that same Region.

\n " + "smithy.api#documentation": "

The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.

\n \n

In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint\n projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support\n sending events to Amazon Pinpoint projects within that same Region.

\n " } }, "PreventUserExistenceErrors": { @@ -12025,13 +12037,13 @@ "EmailConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#EmailConfigurationType", "traits": { - "smithy.api#documentation": "

Email configuration.

" + "smithy.api#documentation": "

The email configuration of your user pool. The email configuration type sets your\n preferred sending method, Amazon Web Services Region, and sender for email invitation and verification\n messages from your user pool.

" } }, "SmsConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#SmsConfigurationType", "traits": { - "smithy.api#documentation": "

SMS configuration.

" + "smithy.api#documentation": "

The SMS configuration with the settings that your Amazon Cognito user pool must use to send an\n SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages\n with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management\n (IAM) role in your Amazon Web Services account.

" } }, "UserPoolTags": { @@ -12507,7 +12519,7 @@ "AnalyticsConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#AnalyticsConfigurationType", "traits": { - "smithy.api#documentation": "

The Amazon Pinpoint analytics configuration for the user pool client.

\n \n

Amazon Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the Region in which the user pool resides.

\n " + "smithy.api#documentation": "

The Amazon Pinpoint analytics configuration for the user pool client.

\n \n

Amazon Cognito user pools only support sending events to Amazon Pinpoint projects in the US East (N.\n Virginia) us-east-1 Region, regardless of the Region where the user pool\n resides.

\n " } }, "PreventUserExistenceErrors": { @@ -12778,13 +12790,13 @@ "EmailConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#EmailConfigurationType", "traits": { - "smithy.api#documentation": "

The email configuration.

" + "smithy.api#documentation": "

The email configuration of your user pool. The email configuration type sets your\n preferred sending method, Amazon Web Services Region, and sender for messages tfrom your user\n pool.

" } }, "SmsConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#SmsConfigurationType", "traits": { - "smithy.api#documentation": "

The SMS configuration.

" + "smithy.api#documentation": "

The SMS configuration with the settings that your Amazon Cognito user pool must use to send an\n SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages\n with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management\n (IAM) role in your Amazon Web Services account.

" } }, "UserPoolTags": { @@ -12796,13 +12808,13 @@ "SmsConfigurationFailure": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "

The reason why the SMS configuration can't send the messages to your users.

\n

This message might include comma-separated values to describe why your SMS configuration can't send messages to user pool end users.

\n \n \n " + "smithy.api#documentation": "

The reason why the SMS configuration can't send the messages to your users.

\n

This message might include comma-separated values to describe why your SMS\n configuration can't send messages to user pool end users.

\n
\n
InvalidSmsRoleAccessPolicyException
\n
\n

The Identity and Access Management role that Amazon Cognito uses to send SMS messages isn't properly\n configured. For more information, see SmsConfigurationType.

\n
\n
SNSSandbox
\n
\n

The Amazon Web Services account is in the SNS SMS Sandbox and messages will\n only reach verified end users. This parameter won’t get populated with\n SNSSandbox if the IAM user creating the user pool doesn’t have SNS\n permissions. To learn how to move your Amazon Web Services account out of the\n sandbox, see Moving out\n of the SMS sandbox.

\n
\n
" } }, "EmailConfigurationFailure": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "

The reason why the email configuration can't send the messages to your users.

" + "smithy.api#documentation": "

Deprecated. Review error codes from API requests with\n EventSource:cognito-idp.amazonaws.com in CloudTrail for\n information about problems with user pool email configuration.

" } }, "Domain": { @@ -12923,7 +12935,7 @@ "UserStatus": { "target": "com.amazonaws.cognitoidentityprovider#UserStatusType", "traits": { - "smithy.api#documentation": "

The user status. This can be one of the following:

\n \n " + "smithy.api#documentation": "

The user status. This can be one of the following:

\n \n " } }, "MFAOptions": { @@ -12964,7 +12976,7 @@ "CaseSensitive": { "target": "com.amazonaws.cognitoidentityprovider#WrappedBooleanType", "traits": { - "smithy.api#documentation": "

Specifies whether username case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs.

\n

Valid values include:

\n \n ", + "smithy.api#documentation": "

Specifies whether username case sensitivity will be applied for all users in the user\n pool through Amazon Cognito APIs.

\n

Valid values include:

\n
\n
True
\n
\n

Enables case sensitivity for all username input. When this option is set\n to True, users must sign in using the exact capitalization of\n their given username, such as “UserName”. This is the default value.

\n
\n
False
\n
\n

Enables case insensitivity for all username input. For example, when this\n option is set to False, users can sign in using either\n \"username\" or \"Username\". This option also enables both\n preferred_username and email alias to be case\n insensitive, in addition to the username attribute.

\n
\n
", "smithy.api#required": {} } } diff --git a/codegen/sdk-codegen/aws-models/config-service.json b/codegen/sdk-codegen/aws-models/config-service.json index 696fe7554955f..446fb1109c453 100644 --- a/codegen/sdk-codegen/aws-models/config-service.json +++ b/codegen/sdk-codegen/aws-models/config-service.json @@ -8299,7 +8299,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates and updates the configuration aggregator with the\n\t\t\tselected source accounts and regions. The source account can be\n\t\t\tindividual account(s) or an organization.

\n\t\t\n\t\t

\n accountIds that are passed will be replaced with existing accounts.\n\t\t\tIf you want to add additional accounts into the aggregator, call DescribeAggregator to get the previous accounts and then append new ones.

\n\t\t \n\t\t\t

Config should be enabled in source accounts and regions\n\t\t\t\tyou want to aggregate.

\n\t\t\t\n\t\t\t

If your source type is an organization, you must be signed in to the management account or a registered delegated administrator and all the features must be enabled in your organization. \n\t\t\t\tIf the caller is a management account, Config calls EnableAwsServiceAccess API to enable integration between Config and Organizations.\n\t\t\t\tIf the caller is a registered delegated administrator, Config calls ListDelegatedAdministrators API to verify whether the caller is a valid delegated administrator.

\n\t\t\t

To register a delegated administrator, see Register a Delegated Administrator in the Config developer guide.

\n\t\t " + "smithy.api#documentation": "

Creates and updates the configuration aggregator with the\n\t\t\tselected source accounts and regions. The source account can be\n\t\t\tindividual account(s) or an organization.

\n\t\t\n\t\t

\n accountIds that are passed will be replaced with existing accounts.\n\t\t\tIf you want to add additional accounts into the aggregator, call DescribeConfigurationAggregators to get the previous accounts and then append new ones.

\n\t\t \n\t\t\t

Config should be enabled in source accounts and regions\n\t\t\t\tyou want to aggregate.

\n\t\t\t\n\t\t\t

If your source type is an organization, you must be signed in to the management account or a registered delegated administrator and all the features must be enabled in your organization. \n\t\t\t\tIf the caller is a management account, Config calls EnableAwsServiceAccess API to enable integration between Config and Organizations.\n\t\t\t\tIf the caller is a registered delegated administrator, Config calls ListDelegatedAdministrators API to verify whether the caller is a valid delegated administrator.

\n\t\t\t

To register a delegated administrator, see Register a Delegated Administrator in the Config developer guide.

\n\t\t " } }, "com.amazonaws.configservice#PutConfigurationAggregatorRequest": { @@ -8429,7 +8429,7 @@ "TemplateBody": { "target": "com.amazonaws.configservice#TemplateBody", "traits": { - "smithy.api#documentation": "

A string containing full conformance pack template body. Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.

\n\t\t \n

You can only use a YAML template with one resource type, that is, config rule and a remediation action.

\n " + "smithy.api#documentation": "

A string containing full conformance pack template body. Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.

\n\t\t \n

You can only use a YAML template with two resource types: config rule (AWS::Config::ConfigRule) and a remediation action (AWS::Config::RemediationConfiguration).

\n " } }, "DeliveryS3Bucket": { @@ -10343,6 +10343,14 @@ { "value": "AWS::CodeDeploy::DeploymentGroup", "name": "CodeDeployDeploymentGroup" + }, + { + "value": "AWS::EC2::LaunchTemplate", + "name": "LaunchTemplate" + }, + { + "value": "AWS::ECR::PublicRepository", + "name": "ECRPublicRepository" } ] } diff --git a/codegen/sdk-codegen/aws-models/connect.json b/codegen/sdk-codegen/aws-models/connect.json index 4ce5bd9ce393c..b97dbd18826ca 100644 --- a/codegen/sdk-codegen/aws-models/connect.json +++ b/codegen/sdk-codegen/aws-models/connect.json @@ -1484,7 +1484,7 @@ "ContentType": { "target": "com.amazonaws.connect#ChatContentType", "traits": { - "smithy.api#documentation": "

The type of the content. Supported types are text and plain.

", + "smithy.api#documentation": "

The type of the content. Supported types are text/plain.

", "smithy.api#required": {} } }, @@ -12934,6 +12934,12 @@ "traits": { "smithy.api#documentation": "

The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. \n The minumum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).

" } + }, + "SupportedMessagingContentTypes": { + "target": "com.amazonaws.connect#SupportedMessagingContentTypes", + "traits": { + "smithy.api#documentation": "

The supported chat message content types. Content types can be text/plain or both text/plain and text/markdown.

" + } } } }, @@ -12983,7 +12989,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts recording the contact when the agent joins the call. StartContactRecording is a\n one-time action. For example, if you use StopContactRecording to stop recording an ongoing call,\n you can't use StartContactRecording to restart it. For scenarios where the recording has started\n and you want to suspend and resume it, such as when collecting sensitive information (for\n example, a credit card number), use SuspendContactRecording and ResumeContactRecording.

\n

You can use this API to override the recording behavior configured in the Set recording\n behavior block.

\n

Only voice recordings are supported at this time.

", + "smithy.api#documentation": "

Starts recording the contact:

\n \n \n

StartContactRecording is a\n one-time action. For example, if you use StopContactRecording to stop recording an ongoing call,\n you can't use StartContactRecording to restart it. For scenarios where the recording has started\n and you want to suspend and resume it, such as when collecting sensitive information (for\n example, a credit card number), use SuspendContactRecording and ResumeContactRecording.

\n

You can use this API to override the recording behavior configured in the Set recording\n behavior block.

\n

Only voice recordings are supported at this time.

", "smithy.api#http": { "method": "POST", "uri": "/contact/start-recording", @@ -13384,7 +13390,7 @@ } ], "traits": { - "smithy.api#documentation": "

Ends the specified contact.

", + "smithy.api#documentation": "

Ends the specified contact. This call does not work for the following initiation methods:

\n ", "smithy.api#http": { "method": "POST", "uri": "/contact/stop", @@ -13569,6 +13575,21 @@ "com.amazonaws.connect#String": { "type": "string" }, + "com.amazonaws.connect#SupportedMessagingContentType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.connect#SupportedMessagingContentTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#SupportedMessagingContentType" + } + }, "com.amazonaws.connect#SuspendContactRecording": { "type": "operation", "input": { diff --git a/codegen/sdk-codegen/aws-models/dataexchange.json b/codegen/sdk-codegen/aws-models/dataexchange.json index 2b01fbe0da903..4d438a6456ead 100644 --- a/codegen/sdk-codegen/aws-models/dataexchange.json +++ b/codegen/sdk-codegen/aws-models/dataexchange.json @@ -262,7 +262,7 @@ } }, "traits": { - "smithy.api#documentation": "

An asset in AWS Data Exchange is a piece of data (S3 object) or a means of fulfilling data (Amazon Redshift datashare or Amazon API Gateway API). The asset can be a structured data file, an image file, or some other data file that can be stored as an S3 object, an Amazon API Gateway API, or an Amazon Redshift datashare (Preview). When you create an import job for your files, API Gateway APIs, or Amazon Redshift datashares, you create an asset in AWS Data Exchange.

" + "smithy.api#documentation": "

An asset in AWS Data Exchange is a piece of data (S3 object) or a means of fulfilling data (Amazon Redshift datashare or Amazon API Gateway API). The asset can be a structured data file, an image file, or some other data file that can be stored as an S3 object, an Amazon API Gateway API, or an Amazon Redshift datashare. When you create an import job for your files, API Gateway APIs, or Amazon Redshift datashares, you create an asset in AWS Data Exchange.

" } }, "com.amazonaws.dataexchange#AssetName": { @@ -712,6 +712,9 @@ { "target": "com.amazonaws.dataexchange#AccessDeniedException" }, + { + "target": "com.amazonaws.dataexchange#ConflictException" + }, { "target": "com.amazonaws.dataexchange#InternalServerException" }, @@ -927,6 +930,24 @@ "traits": { "smithy.api#documentation": "

The date and time that the revision was last updated, in ISO 8601 format.

" } + }, + "RevocationComment": { + "target": "com.amazonaws.dataexchange#__stringMin10Max512", + "traits": { + "smithy.api#documentation": "

A required comment to inform subscribers of the reason their access to the revision was revoked.

" + } + }, + "Revoked": { + "target": "com.amazonaws.dataexchange#__boolean", + "traits": { + "smithy.api#documentation": "

A status indicating that subscribers' access to the revision was revoked.

" + } + }, + "RevokedAt": { + "target": "com.amazonaws.dataexchange#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the revision was revoked, in ISO 8601 format.

" + } } } }, @@ -1009,6 +1030,9 @@ { "target": "com.amazonaws.dataexchange#ListTagsForResource" }, + { + "target": "com.amazonaws.dataexchange#RevokeRevision" + }, { "target": "com.amazonaws.dataexchange#SendApiAsset" }, @@ -2175,6 +2199,24 @@ "traits": { "smithy.api#documentation": "

The date and time that the revision was last updated, in ISO 8601 format.

" } + }, + "RevocationComment": { + "target": "com.amazonaws.dataexchange#__stringMin10Max512", + "traits": { + "smithy.api#documentation": "

A required comment to inform subscribers of the reason their access to the revision was revoked.

" + } + }, + "Revoked": { + "target": "com.amazonaws.dataexchange#__boolean", + "traits": { + "smithy.api#documentation": "

A status indicating that subscribers' access to the revision was revoked.

" + } + }, + "RevokedAt": { + "target": "com.amazonaws.dataexchange#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the revision was revoked, in ISO 8601 format.

" + } } } }, @@ -3695,6 +3737,24 @@ "smithy.api#documentation": "

The date and time that the revision was last updated, in ISO 8601 format.

", "smithy.api#required": {} } + }, + "RevocationComment": { + "target": "com.amazonaws.dataexchange#__stringMin10Max512", + "traits": { + "smithy.api#documentation": "

A required comment to inform subscribers of the reason their access to the revision was revoked.

" + } + }, + "Revoked": { + "target": "com.amazonaws.dataexchange#__boolean", + "traits": { + "smithy.api#documentation": "

A status indicating that subscribers' access to the revision was revoked.

" + } + }, + "RevokedAt": { + "target": "com.amazonaws.dataexchange#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the revision was revoked, in ISO 8601 format.

" + } } }, "traits": { @@ -3716,6 +3776,145 @@ "smithy.api#documentation": "

Information about the published revision.

" } }, + "com.amazonaws.dataexchange#RevokeRevision": { + "type": "operation", + "input": { + "target": "com.amazonaws.dataexchange#RevokeRevisionRequest" + }, + "output": { + "target": "com.amazonaws.dataexchange#RevokeRevisionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.dataexchange#AccessDeniedException" + }, + { + "target": "com.amazonaws.dataexchange#ConflictException" + }, + { + "target": "com.amazonaws.dataexchange#InternalServerException" + }, + { + "target": "com.amazonaws.dataexchange#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.dataexchange#ThrottlingException" + }, + { + "target": "com.amazonaws.dataexchange#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

This operation revokes subscribers' access to a revision.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/data-sets/{DataSetId}/revisions/{RevisionId}/revoke", + "code": 200 + } + } + }, + "com.amazonaws.dataexchange#RevokeRevisionRequest": { + "type": "structure", + "members": { + "DataSetId": { + "target": "com.amazonaws.dataexchange#__string", + "traits": { + "smithy.api#documentation": "

The unique identifier for a data set.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RevisionId": { + "target": "com.amazonaws.dataexchange#__string", + "traits": { + "smithy.api#documentation": "

The unique identifier for a revision.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RevocationComment": { + "target": "com.amazonaws.dataexchange#__stringMin10Max512", + "traits": { + "smithy.api#documentation": "

A required comment to inform subscribers of the reason their access to the revision was revoked.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The request body for RevokeRevision.

" + } + }, + "com.amazonaws.dataexchange#RevokeRevisionResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.dataexchange#Arn", + "traits": { + "smithy.api#documentation": "

The ARN for the revision.

" + } + }, + "Comment": { + "target": "com.amazonaws.dataexchange#__stringMin0Max16384", + "traits": { + "smithy.api#documentation": "

An optional comment about the revision.

" + } + }, + "CreatedAt": { + "target": "com.amazonaws.dataexchange#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the revision was created, in ISO 8601 format.

" + } + }, + "DataSetId": { + "target": "com.amazonaws.dataexchange#Id", + "traits": { + "smithy.api#documentation": "

The unique identifier for the data set associated with this revision.

" + } + }, + "Finalized": { + "target": "com.amazonaws.dataexchange#__boolean", + "traits": { + "smithy.api#documentation": "

To publish a revision to a data set in a product, the revision must first be finalized. Finalizing a revision tells AWS Data Exchange that changes to the assets in the revision are complete. After it's in this read-only state, you can publish the revision to your products.

Finalized revisions can be published through the AWS Data Exchange console or the AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API action. When using the API, revisions are uniquely identified by their ARN.

" + } + }, + "Id": { + "target": "com.amazonaws.dataexchange#Id", + "traits": { + "smithy.api#documentation": "

The unique identifier for the revision.

" + } + }, + "SourceId": { + "target": "com.amazonaws.dataexchange#Id", + "traits": { + "smithy.api#documentation": "

The revision ID of the owned revision corresponding to the entitled revision being viewed. This parameter is returned when a revision owner is viewing the entitled copy of its owned revision.

" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.dataexchange#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the revision was last updated, in ISO 8601 format.

" + } + }, + "RevocationComment": { + "target": "com.amazonaws.dataexchange#__stringMin10Max512", + "traits": { + "smithy.api#documentation": "

A required comment to inform subscribers of the reason their access to the revision was revoked.

" + } + }, + "Revoked": { + "target": "com.amazonaws.dataexchange#__boolean", + "traits": { + "smithy.api#documentation": "

A status indicating that subscribers' access to the revision was revoked.

" + } + }, + "RevokedAt": { + "target": "com.amazonaws.dataexchange#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the revision was revoked, in ISO 8601 format.

" + } + } + } + }, "com.amazonaws.dataexchange#S3SnapshotAsset": { "type": "structure", "members": { @@ -4604,6 +4803,24 @@ "traits": { "smithy.api#documentation": "

The date and time that the revision was last updated, in ISO 8601 format.

" } + }, + "RevocationComment": { + "target": "com.amazonaws.dataexchange#__stringMin10Max512", + "traits": { + "smithy.api#documentation": "

A required comment to inform subscribers of the reason their access to the revision was revoked.

" + } + }, + "Revoked": { + "target": "com.amazonaws.dataexchange#__boolean", + "traits": { + "smithy.api#documentation": "

A status indicating that subscribers' access to the revision was revoked.

" + } + }, + "RevokedAt": { + "target": "com.amazonaws.dataexchange#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the revision was revoked, in ISO 8601 format.

" + } } } }, @@ -4651,6 +4868,15 @@ } } }, + "com.amazonaws.dataexchange#__stringMin10Max512": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 512 + } + } + }, "com.amazonaws.dataexchange#__stringMin24Max24PatternAZaZ094AZaZ092AZaZ093": { "type": "string", "traits": { diff --git a/codegen/sdk-codegen/aws-models/ec2.json b/codegen/sdk-codegen/aws-models/ec2.json index 81656826042e5..5b4a01a3323a6 100644 --- a/codegen/sdk-codegen/aws-models/ec2.json +++ b/codegen/sdk-codegen/aws-models/ec2.json @@ -16426,6 +16426,12 @@ "smithy.api#documentation": "

The ID of the IPAM to delete.

", "smithy.api#required": {} } + }, + "Cascade": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and\n any allocations in the pools in private scopes. You cannot delete the IPAM with this option if there is a pool in your public scope. If you use this option, IPAM does the following:

\n " + } } } }, @@ -48809,7 +48815,7 @@ } }, "traits": { - "smithy.api#documentation": "

In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.

\n

For more information, see How IPAM works in the Amazon VPC IPAM User Guide\n

" + "smithy.api#documentation": "

In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.

\n

For more information, see How IPAM works in the Amazon VPC IPAM User Guide.

" } }, "com.amazonaws.ec2#IpamScopeId": { @@ -56750,7 +56756,7 @@ "target": "com.amazonaws.ec2#MoveByoipCidrToIpamResult" }, "traits": { - "smithy.api#documentation": "

Move an BYOIP IPv4 CIDR to IPAM from a public IPv4 pool.

" + "smithy.api#documentation": "

Move an BYOIP IPv4 CIDR to IPAM from a public IPv4 pool.

\n

If you already have an IPv4 BYOIP CIDR with Amazon Web Services, you can move the CIDR to IPAM from a public IPv4 pool. You cannot move an IPv6 CIDR to IPAM. If you are bringing a new IP address to Amazon Web Services for the first time, complete the steps in Tutorial: BYOIP address CIDRs to IPAM.

" } }, "com.amazonaws.ec2#MoveByoipCidrToIpamRequest": { @@ -60950,7 +60956,7 @@ "target": "com.amazonaws.ec2#ProvisionIpamPoolCidrResult" }, "traits": { - "smithy.api#documentation": "

Provision a CIDR to an IPAM pool. You can use thsi action to provision new CIDRs to a top-level pool or to transfer a CIDR from a top-level pool to a pool within it.

\n

For more information, see Provision CIDRs to pools in the Amazon VPC IPAM User Guide.\n

" + "smithy.api#documentation": "

Provision a CIDR to an IPAM pool. You can use this action to provision new CIDRs to a top-level pool or to transfer a CIDR from a top-level pool to a pool within it.

\n

For more information, see Provision CIDRs to pools in the Amazon VPC IPAM User Guide.\n

" } }, "com.amazonaws.ec2#ProvisionIpamPoolCidrRequest": { @@ -61005,7 +61011,7 @@ "target": "com.amazonaws.ec2#ProvisionPublicIpv4PoolCidrResult" }, "traits": { - "smithy.api#documentation": "

Provision a CIDR to a public IPv4 pool.

\n

For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.\n

" + "smithy.api#documentation": "

Provision a CIDR to a public IPv4 pool.

\n

For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.

" } }, "com.amazonaws.ec2#ProvisionPublicIpv4PoolCidrRequest": { @@ -62530,7 +62536,8 @@ "IpamPoolAllocationId": { "target": "com.amazonaws.ec2#IpamPoolAllocationId", "traits": { - "smithy.api#documentation": "

The ID of the allocation.

" + "smithy.api#documentation": "

The ID of the allocation.

", + "smithy.api#required": {} } } } diff --git a/codegen/sdk-codegen/aws-models/ecr.json b/codegen/sdk-codegen/aws-models/ecr.json index c9c1d887318ce..95244993917ff 100644 --- a/codegen/sdk-codegen/aws-models/ecr.json +++ b/codegen/sdk-codegen/aws-models/ecr.json @@ -1427,7 +1427,6 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "imageScanFindings.findings", "pageSize": "maxResults" }, "smithy.waiters#waitable": { @@ -5207,7 +5206,7 @@ } }, "traits": { - "smithy.api#documentation": "

The details of a scanning repository filter.

" + "smithy.api#documentation": "

The details of a scanning repository filter. For more information on how to use\n filters, see Using\n filters in the Amazon Elastic Container Registry User Guide.

" } }, "com.amazonaws.ecr#ScanningRepositoryFilterList": { diff --git a/codegen/sdk-codegen/aws-models/ecs.json b/codegen/sdk-codegen/aws-models/ecs.json index 95e9dd8de59bb..f485bd90be289 100644 --- a/codegen/sdk-codegen/aws-models/ecs.json +++ b/codegen/sdk-codegen/aws-models/ecs.json @@ -1799,7 +1799,7 @@ "configuration": { "target": "com.amazonaws.ecs#ClusterConfiguration", "traits": { - "smithy.api#documentation": "

The\n\t\t\texecute command configuration for the cluster.

" + "smithy.api#documentation": "

The execute command configuration for the cluster.

" } }, "capacityProviders": { @@ -1992,7 +1992,7 @@ "propagateTags": { "target": "com.amazonaws.ecs#PropagateTags", "traits": { - "smithy.api#documentation": "

Specifies whether to propagate the tags from the task definition or the service to the\n\t\t\ttasks in the service. If no value is specified, the tags aren't propagated. Tags can\n\t\t\tonly be propagated to the tasks within the service during service creation. To add tags\n\t\t\tto a task after service creation or task creation, use the TagResource\n\t\t\tAPI action.

" + "smithy.api#documentation": "

Specifies whether to propagate the tags from the task definition to the task. If no\n\t\t\tvalue is specified, the tags aren't propagated. Tags can only be propagated to the task\n\t\t\tduring task creation. To add tags to a task after task creation, use the TagResource API action.

" } }, "enableExecuteCommand": { @@ -4082,7 +4082,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object representing a container health check. Health check parameters that are\n\t\t\tspecified in a container definition override any Docker health checks that exist in the\n\t\t\tcontainer image (such as those specified in a parent image or from the image's\n\t\t\tDockerfile).

\n\t\t

You can view the health status of both individual containers and a task with the\n\t\t\tDescribeTasks API operation or when viewing the task details in the console.

\n\t\t

The following describes the possible healthStatus values for a\n\t\t\tcontainer:

\n\t\t \n\t\t

The following describes the possible healthStatus values for a task. The\n\t\t\tcontainer health check status of nonessential containers do not have an effect on the\n\t\t\thealth status of a task.

\n\t\t \n\t\t

If a task is run manually, and not as part of a service, the task will continue its\n\t\t\tlifecycle regardless of its health status. For tasks that are part of a service, if the\n\t\t\ttask reports as unhealthy then the task will be stopped and the service scheduler will\n\t\t\treplace it.

\n\t\t

The following are notes about container health check support:

\n\t\t " + "smithy.api#documentation": "

An object representing a container health check. Health check parameters that are\n\t\t\tspecified in a container definition override any Docker health checks that exist in the\n\t\t\tcontainer image (such as those specified in a parent image or from the image's\n\t\t\tDockerfile).

\n\t\t \n\t\t\t

The Amazon ECS container agent only monitors and reports on the health\n\t\t\t\tchecks specified in the task definition. Amazon ECS does not monitor\n\t\t\t\tDocker health checks that are embedded in a container image and not\n\t\t\t\tspecified in the container definition. Health check parameters that\n\t\t\t\tare specified in a container definition override any Docker health\n\t\t\t\tchecks that exist in the container image.

\n\t\t \n\t\t

You can view the health status of both individual containers and a task with the\n\t\t\tDescribeTasks API operation or when viewing the task details in the console.

\n\t\t

The following describes the possible healthStatus values for a\n\t\t\tcontainer:

\n\t\t \n\t\t

The following describes the possible healthStatus values for a task. The\n\t\t\tcontainer health check status of nonessential containers do not have an effect on the\n\t\t\thealth status of a task.

\n\t\t \n\t\t

If a task is run manually, and not as part of a service, the task will continue its\n\t\t\tlifecycle regardless of its health status. For tasks that are part of a service, if the\n\t\t\ttask reports as unhealthy then the task will be stopped and the service scheduler will\n\t\t\treplace it.

\n\t\t

The following are notes about container health check support:

\n\t\t " } }, "com.amazonaws.ecs#HealthStatus": { @@ -6598,7 +6598,7 @@ "enableExecuteCommand": { "target": "com.amazonaws.ecs#Boolean", "traits": { - "smithy.api#documentation": "

Determines whether to use the execute command functionality for the containers in\n\t\t\tthis task. If true, this enables execute command functionality on all\n\t\t\tcontainers in the task.

" + "smithy.api#documentation": "

Determines whether to use the execute command functionality for the containers in\n\t\t\tthis task. If true, this enables execute command functionality on all\n\t\t\tcontainers in the task.

\n\t\t

If true, then the task definition must have a task role, or you must\n\t\t\tprovide one as an override.

" } }, "group": { @@ -6670,7 +6670,7 @@ "taskDefinition": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The family and revision (family:revision) or\n\t\t\tfull ARN of the task definition to run. If a revision isn't specified,\n\t\t\tthe latest ACTIVE revision is used.

\n\t\t

The full ARN value must match the value that you specified as the\n\t\t\t\tResource of the IAM principal's permissions policy. For example, if the\n\t\t\t\tResource is\n\t\t\tarn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*, the\n\t\t\t\ttaskDefinition ARN value must be\n\t\t\t\tarn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName.

", + "smithy.api#documentation": "

The family and revision (family:revision) or\n\t\t\tfull ARN of the task definition to run. If a revision isn't specified,\n\t\t\tthe latest ACTIVE revision is used.

\n\t\t

When you create an IAM policy for run-task, you can set the resource to be the latest task definition revision, or a specific revision.

\n\t\t

The full ARN value must match the value that you specified as the Resource of\n\t\t\tthe IAM principal's permissions policy.

\n\t\t

When you specify the policy resource as the latest task definition version (by setting the\n\t\t\t\tResource in the policy to\n\t\t\t\tarn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName),\n\t\t\tthen set this value to\n\t\t\t\tarn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName.

\n\t\t

When you specify the policy resource as a specific task definition version (by setting the\n\t\t\t\tResource in the policy to\n\t\t\t\tarn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1 or\n\t\t\t\tarn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*),\n\t\t\tthen set this value to\n\t\t\t\tarn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1.

\n\t\t

For more information, see Policy Resources for Amazon ECS in the Amazon Elastic Container Service\n\t\t\tdeveloper Guide.

", "smithy.api#required": {} } } @@ -7841,7 +7841,7 @@ } }, "traits": { - "smithy.api#documentation": "

The target container isn't properly configured with the execute command agent or the\n\t\t\tcontainer is no longer active or running.

", + "smithy.api#documentation": "

The execute command cannot run. This error can be caused by any of the following\n\t\t\tconfiguration issues:

\n\t\t \n\t\t\t

For information about how to troubleshoot the\n\t\t\tissues, see Troubleshooting issues with ECS Exec in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

", "smithy.api#error": "client" } }, @@ -9086,7 +9086,7 @@ } ], "traits": { - "smithy.api#documentation": "

Modifies the status of an Amazon ECS container instance.

\n\t\t

Once a container instance has reached an ACTIVE state, you can change the\n\t\t\tstatus of a container instance to DRAINING to manually remove an instance\n\t\t\tfrom a cluster, for example to perform system updates, update the Docker daemon, or\n\t\t\tscale down the cluster size.

\n\t\t \n\t\t\t

A container instance can't be changed to DRAINING until it has\n\t\t\t\treached an ACTIVE status. If the instance is in any other status, an\n\t\t\t\terror will be received.

\n\t\t \n\t\t

When you set a container instance to DRAINING, Amazon ECS prevents new tasks\n\t\t\tfrom being scheduled for placement on the container instance and replacement service\n\t\t\ttasks are started on other container instances in the cluster if the resources are\n\t\t\tavailable. Service tasks on the container instance that are in the PENDING\n\t\t\tstate are stopped immediately.

\n\t\t

Service tasks on the container instance that are in the RUNNING state are\n\t\t\tstopped and replaced according to the service's deployment configuration parameters,\n\t\t\t\tminimumHealthyPercent and maximumPercent. You can change\n\t\t\tthe deployment configuration of your service using UpdateService.

\n\t\t \n\t\t

Any PENDING or RUNNING tasks that do not belong to a service\n\t\t\taren't affected. You must wait for them to finish or stop them manually.

\n\t\t

A container instance has completed draining when it has no more RUNNING\n\t\t\ttasks. You can verify this using ListTasks.

\n\t\t

When a container instance has been drained, you can set a container instance to\n\t\t\t\tACTIVE status and once it has reached that status the Amazon ECS scheduler\n\t\t\tcan begin scheduling tasks on the instance again.

" + "smithy.api#documentation": "

Modifies the status of an Amazon ECS container instance.

\n\t\t

Once a container instance has reached an ACTIVE state, you can change the\n\t\t\tstatus of a container instance to DRAINING to manually remove an instance\n\t\t\tfrom a cluster, for example to perform system updates, update the Docker daemon, or\n\t\t\tscale down the cluster size.

\n\t\t \n\t\t\t

A container instance can't be changed to DRAINING until it has\n\t\t\t\treached an ACTIVE status. If the instance is in any other status, an\n\t\t\t\terror will be received.

\n\t\t \n\t\t

When you set a container instance to DRAINING, Amazon ECS prevents new tasks\n\t\t\tfrom being scheduled for placement on the container instance and replacement service\n\t\t\ttasks are started on other container instances in the cluster if the resources are\n\t\t\tavailable. Service tasks on the container instance that are in the PENDING\n\t\t\tstate are stopped immediately.

\n\t\t

Service tasks on the container instance that are in the RUNNING state are\n\t\t\tstopped and replaced according to the service's deployment configuration parameters,\n\t\t\t\tminimumHealthyPercent and maximumPercent. You can change\n\t\t\tthe deployment configuration of your service using UpdateService.

\n\t\t \n\t\t

Any PENDING or RUNNING tasks that do not belong to a service\n\t\t\taren't affected. You must wait for them to finish or stop them manually.

\n\t\t

A container instance has completed draining when it has no more RUNNING\n\t\t\ttasks. You can verify this using ListTasks.

\n\t\t

When a container instance has been drained, you can set a container instance to\n\t\t\t\tACTIVE status and once it has reached that status the Amazon ECS scheduler\n\t\t\tcan begin scheduling tasks on the instance again.

" } }, "com.amazonaws.ecs#UpdateContainerInstancesStateRequest": { @@ -9181,7 +9181,7 @@ } ], "traits": { - "smithy.api#documentation": "\n\t\t\t

Updating the task placement strategies and constraints on an Amazon ECS service remains\n\t\t\t\tin preview and is a Beta Service as defined by and subject to the Beta Service\n\t\t\t\tParticipation Service Terms located at https://aws.amazon.com/service-terms (\"Beta Terms\"). These Beta Terms\n\t\t\t\tapply to your participation in this preview.

\n\t\t \n\t\t

Modifies the parameters of a service.

\n\t\t

For services using the rolling update (ECS) you can update the desired count,\n\t\t\tthe deployment configuration, the network configuration, load balancers, service\n\t\t\tregistries, enable ECS managed tags option, propagate tags option, task placement\n\t\t\tconstraints and strategies, and the task definition. When you update any of these\n\t\t\tparameters, Amazon ECS starts new tasks with the new configuration.

\n\t\t

For services using the blue/green (CODE_DEPLOY) deployment controller, only the\n\t\t\tdesired count, deployment configuration, task placement constraints and strategies,\n\t\t\tenable ECS managed tags option, and propagate tags can be updated using this API. If the\n\t\t\tnetwork configuration, platform version, task definition, or load balancer need to be\n\t\t\tupdated, create a new CodeDeploy deployment. For more information, see CreateDeployment in the CodeDeploy API Reference.

\n\t\t

For services using an external deployment controller, you can update only the desired count,\n\t\t\ttask placement constraints and strategies, health check grace period, enable ECS managed\n\t\t\ttags option, and propagate tags option, using this API. If the launch type, load\n\t\t\tbalancer, network configuration, platform version, or task definition need to be\n\t\t\tupdated, create a new task set For more information, see CreateTaskSet.

\n\t\t

You can add to or subtract from the number of instantiations of a task definition in a\n\t\t\tservice by specifying the cluster that the service is running in and a new\n\t\t\t\tdesiredCount parameter.

\n\t\t

If you have updated the Docker image of your application, you can create a new task\n\t\t\tdefinition with that image and deploy it to your service. The service scheduler uses the\n\t\t\tminimum healthy percent and maximum percent parameters (in the service's deployment\n\t\t\tconfiguration) to determine the deployment strategy.

\n\t\t \n\t\t\t

If your updated Docker image uses the same tag as what is in the existing task\n\t\t\t\tdefinition for your service (for example, my_image:latest), you don't\n\t\t\t\tneed to create a new revision of your task definition. You can update the service\n\t\t\t\tusing the forceNewDeployment option. The new tasks launched by the\n\t\t\t\tdeployment pull the current image/tag combination from your repository when they\n\t\t\t\tstart.

\n\t\t \n\t\t

You can also update the deployment configuration of a service. When a deployment is\n\t\t\ttriggered by updating the task definition of a service, the service scheduler uses the\n\t\t\tdeployment configuration parameters, minimumHealthyPercent and\n\t\t\t\tmaximumPercent, to determine the deployment strategy.

\n\t\t \n\t\t

When UpdateService stops a task during a deployment, the equivalent\n\t\t\tof docker stop is issued to the containers running in the task. This\n\t\t\tresults in a SIGTERM and a 30-second timeout. After this,\n\t\t\t\tSIGKILL is sent and the containers are forcibly stopped. If the\n\t\t\tcontainer handles the SIGTERM gracefully and exits within 30 seconds from\n\t\t\treceiving it, no SIGKILL is sent.

\n\t\t

When the service scheduler launches new tasks, it determines task placement in your\n\t\t\tcluster with the following logic.

\n\t\t \n\t\t\n\t\t

When the service scheduler stops running tasks, it attempts to maintain balance across\n\t\t\tthe Availability Zones in your cluster using the following logic:

\n\t\t \n\t\t \n\t\t

You must have a service-linked role when you update any of the following service properties.\n\t\t\tIf you specified a custom IAM role when you created the service, Amazon ECS automatically\n\t\t\treplaces the roleARN associated with the service with the ARN of your service-linked\n\t\t\trole. For more information, see Service-linked\n\t\t\t\troles in the Amazon Elastic Container Service Developer Guide.

\n\t\t \n\t\t " + "smithy.api#documentation": "\n\t\t\t

Updating the task placement strategies and constraints on an Amazon ECS service remains\n\t\t\t\tin preview and is a Beta Service as defined by and subject to the Beta Service\n\t\t\t\tParticipation Service Terms located at https://aws.amazon.com/service-terms (\"Beta Terms\"). These Beta Terms\n\t\t\t\tapply to your participation in this preview.

\n\t\t \n\t\t

Modifies the parameters of a service.

\n\t\t

For services using the rolling update (ECS) you can update the desired count,\n\t\t\tdeployment configuration, network configuration, load balancers, service registries,\n\t\t\tenable ECS managed tags option, propagate tags option, task placement constraints and\n\t\t\tstrategies, and task definition. When you update any of these parameters, Amazon ECS starts\n\t\t\tnew tasks with the new configuration.

\n\t\t

For services using the blue/green (CODE_DEPLOY) deployment controller, only the\n\t\t\tdesired count, deployment configuration, health check grace period, task placement\n\t\t\tconstraints and strategies, enable ECS managed tags option, and propagate tags can be\n\t\t\tupdated using this API. If the network configuration, platform version, task definition,\n\t\t\tor load balancer need to be updated, create a new CodeDeploy deployment. For more\n\t\t\tinformation, see CreateDeployment in the CodeDeploy API Reference.

\n\t\t

For services using an external deployment controller, you can update only the desired count,\n\t\t\ttask placement constraints and strategies, health check grace period, enable ECS managed\n\t\t\ttags option, and propagate tags option, using this API. If the launch type, load\n\t\t\tbalancer, network configuration, platform version, or task definition need to be\n\t\t\tupdated, create a new task set For more information, see CreateTaskSet.

\n\t\t

You can add to or subtract from the number of instantiations of a task definition in a\n\t\t\tservice by specifying the cluster that the service is running in and a new\n\t\t\t\tdesiredCount parameter.

\n\t\t

If you have updated the Docker image of your application, you can create a new task\n\t\t\tdefinition with that image and deploy it to your service. The service scheduler uses the\n\t\t\tminimum healthy percent and maximum percent parameters (in the service's deployment\n\t\t\tconfiguration) to determine the deployment strategy.

\n\t\t \n\t\t\t

If your updated Docker image uses the same tag as what is in the existing task\n\t\t\t\tdefinition for your service (for example, my_image:latest), you don't\n\t\t\t\tneed to create a new revision of your task definition. You can update the service\n\t\t\t\tusing the forceNewDeployment option. The new tasks launched by the\n\t\t\t\tdeployment pull the current image/tag combination from your repository when they\n\t\t\t\tstart.

\n\t\t \n\t\t

You can also update the deployment configuration of a service. When a deployment is\n\t\t\ttriggered by updating the task definition of a service, the service scheduler uses the\n\t\t\tdeployment configuration parameters, minimumHealthyPercent and\n\t\t\t\tmaximumPercent, to determine the deployment strategy.

\n\t\t \n\t\t

When UpdateService stops a task during a deployment, the equivalent\n\t\t\tof docker stop is issued to the containers running in the task. This\n\t\t\tresults in a SIGTERM and a 30-second timeout. After this,\n\t\t\t\tSIGKILL is sent and the containers are forcibly stopped. If the\n\t\t\tcontainer handles the SIGTERM gracefully and exits within 30 seconds from\n\t\t\treceiving it, no SIGKILL is sent.

\n\t\t

When the service scheduler launches new tasks, it determines task placement in your\n\t\t\tcluster with the following logic.

\n\t\t \n\t\t\n\t\t

When the service scheduler stops running tasks, it attempts to maintain balance across\n\t\t\tthe Availability Zones in your cluster using the following logic:

\n\t\t \n\t\t \n\t\t

You must have a service-linked role when you update any of the following service properties.\n\t\t\tIf you specified a custom IAM role when you created the service, Amazon ECS automatically\n\t\t\treplaces the roleARN associated with the service with the ARN of your service-linked\n\t\t\trole. For more information, see Service-linked\n\t\t\t\troles in the Amazon Elastic Container Service Developer Guide.

\n\t\t \n\t\t " } }, "com.amazonaws.ecs#UpdateServicePrimaryTaskSet": { diff --git a/codegen/sdk-codegen/aws-models/elasticache.json b/codegen/sdk-codegen/aws-models/elasticache.json index 16a5b95b06db4..34f8080050109 100644 --- a/codegen/sdk-codegen/aws-models/elasticache.json +++ b/codegen/sdk-codegen/aws-models/elasticache.json @@ -981,7 +981,7 @@ "CacheParameterGroupFamily": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of the cache parameter group family associated with this cache engine.

\n

Valid values are: \n memcached1.4 | \n memcached1.5 | \n memcached1.6 | \n redis2.6 | \n redis2.8 |\n redis3.2 |\n redis4.0 |\n redis5.0 | \n redis6.0 | \n redis6.2\n

" + "smithy.api#documentation": "

The name of the cache parameter group family associated with this cache engine.

\n

Valid values are: \n memcached1.4 | \n memcached1.5 | \n memcached1.6 | \n redis2.6 | \n redis2.8 |\n redis3.2 |\n redis4.0 |\n redis5.0 | \n redis6.x \n

" } }, "CacheEngineDescription": { @@ -5254,7 +5254,7 @@ "CacheParameterGroupFamily": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

Specifies the name of the cache parameter group family to which the engine default parameters apply.

\n

Valid values are: \n memcached1.4 | \n memcached1.5 | \n memcached1.6 | \n redis2.6 | \n redis2.8 |\n redis3.2 |\n redis4.0 |\n redis5.0 | \n redis6.0 | \n redis6.2\n

" + "smithy.api#documentation": "

Specifies the name of the cache parameter group family to which the engine default parameters apply.

\n

Valid values are: \n memcached1.4 | \n memcached1.5 | \n memcached1.6 | \n redis2.6 | \n redis2.8 |\n redis3.2 |\n redis4.0 |\n redis5.0 | \n redis6.0 | \n redis6.x\n

" } }, "Marker": { diff --git a/codegen/sdk-codegen/aws-models/glue.json b/codegen/sdk-codegen/aws-models/glue.json index bf6eb80dc769b..e49dd2fdf81d7 100644 --- a/codegen/sdk-codegen/aws-models/glue.json +++ b/codegen/sdk-codegen/aws-models/glue.json @@ -93,6 +93,9 @@ { "target": "com.amazonaws.glue#CancelMLTaskRun" }, + { + "target": "com.amazonaws.glue#CancelStatement" + }, { "target": "com.amazonaws.glue#CheckSchemaVersionValidity" }, @@ -138,6 +141,9 @@ { "target": "com.amazonaws.glue#CreateSecurityConfiguration" }, + { + "target": "com.amazonaws.glue#CreateSession" + }, { "target": "com.amazonaws.glue#CreateTable" }, @@ -201,6 +207,9 @@ { "target": "com.amazonaws.glue#DeleteSecurityConfiguration" }, + { + "target": "com.amazonaws.glue#DeleteSession" + }, { "target": "com.amazonaws.glue#DeleteTable" }, @@ -342,6 +351,12 @@ { "target": "com.amazonaws.glue#GetSecurityConfigurations" }, + { + "target": "com.amazonaws.glue#GetSession" + }, + { + "target": "com.amazonaws.glue#GetStatement" + }, { "target": "com.amazonaws.glue#GetTable" }, @@ -417,6 +432,12 @@ { "target": "com.amazonaws.glue#ListSchemaVersions" }, + { + "target": "com.amazonaws.glue#ListSessions" + }, + { + "target": "com.amazonaws.glue#ListStatements" + }, { "target": "com.amazonaws.glue#ListTriggers" }, @@ -450,6 +471,9 @@ { "target": "com.amazonaws.glue#ResumeWorkflowRun" }, + { + "target": "com.amazonaws.glue#RunStatement" + }, { "target": "com.amazonaws.glue#SearchTables" }, @@ -489,6 +513,9 @@ { "target": "com.amazonaws.glue#StopCrawlerSchedule" }, + { + "target": "com.amazonaws.glue#StopSession" + }, { "target": "com.amazonaws.glue#StopTrigger" }, @@ -658,12 +685,36 @@ "com.amazonaws.glue#AttemptCount": { "type": "integer" }, + "com.amazonaws.glue#AuditColumnNamesList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#ColumnNameString" + } + }, "com.amazonaws.glue#AuditContext": { "type": "structure", "members": { "AdditionalAuditContext": { - "target": "com.amazonaws.glue#AuditContextString" + "target": "com.amazonaws.glue#AuditContextString", + "traits": { + "smithy.api#documentation": "

The context for the audit..

" + } + }, + "RequestedColumns": { + "target": "com.amazonaws.glue#AuditColumnNamesList", + "traits": { + "smithy.api#documentation": "

The requested columns for audit.

" + } + }, + "AllColumnsRequested": { + "target": "com.amazonaws.glue#NullableBoolean", + "traits": { + "smithy.api#documentation": "

All columns request for audit.

" + } } + }, + "traits": { + "smithy.api#documentation": "

A structure containing information for audit.

" } }, "com.amazonaws.glue#AuditContextString": { @@ -2221,6 +2272,67 @@ } } }, + "com.amazonaws.glue#CancelStatement": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#CancelStatementRequest" + }, + "output": { + "target": "com.amazonaws.glue#CancelStatementResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#IllegalSessionStateException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "

Cancels the statement..

" + } + }, + "com.amazonaws.glue#CancelStatementRequest": { + "type": "structure", + "members": { + "SessionId": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The Session ID of the statement to be cancelled.

", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.glue#IntegerValue", + "traits": { + "smithy.api#documentation": "

The ID of the statement to be cancelled.

", + "smithy.api#required": {} + } + }, + "RequestOrigin": { + "target": "com.amazonaws.glue#OrchestrationNameString", + "traits": { + "smithy.api#documentation": "

The origin of the request to cancel the statement.

" + } + } + } + }, + "com.amazonaws.glue#CancelStatementResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.glue#CatalogEncryptionMode": { "type": "string", "traits": { @@ -5454,6 +5566,156 @@ } } }, + "com.amazonaws.glue#CreateSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#CreateSessionRequest" + }, + "output": { + "target": "com.amazonaws.glue#CreateSessionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#AlreadyExistsException" + }, + { + "target": "com.amazonaws.glue#IdempotentParameterMismatchException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + }, + { + "target": "com.amazonaws.glue#ResourceNumberLimitExceededException" + }, + { + "target": "com.amazonaws.glue#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new session.

" + } + }, + "com.amazonaws.glue#CreateSessionRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The ID of the session request.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.glue#DescriptionString", + "traits": { + "smithy.api#documentation": "

The description of the session.

" + } + }, + "Role": { + "target": "com.amazonaws.glue#OrchestrationRoleArn", + "traits": { + "smithy.api#documentation": "

The IAM Role ARN

", + "smithy.api#required": {} + } + }, + "Command": { + "target": "com.amazonaws.glue#SessionCommand", + "traits": { + "smithy.api#documentation": "

The SessionCommand that runs the job.

", + "smithy.api#required": {} + } + }, + "Timeout": { + "target": "com.amazonaws.glue#Timeout", + "traits": { + "smithy.api#documentation": "

The number of seconds before request times out.

" + } + }, + "IdleTimeout": { + "target": "com.amazonaws.glue#Timeout", + "traits": { + "smithy.api#documentation": "

The number of seconds when idle before request times out.

" + } + }, + "DefaultArguments": { + "target": "com.amazonaws.glue#OrchestrationArgumentsMap", + "traits": { + "smithy.api#documentation": "

A map array of key-value pairs. Max is 75 pairs.

" + } + }, + "Connections": { + "target": "com.amazonaws.glue#ConnectionsList", + "traits": { + "smithy.api#documentation": "

The number of connections to use for the session.

" + } + }, + "MaxCapacity": { + "target": "com.amazonaws.glue#NullableDouble", + "traits": { + "smithy.api#documentation": "

The number of AWS Glue data processing units (DPUs) that can be allocated when the job runs. \n A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB memory.

" + } + }, + "NumberOfWorkers": { + "target": "com.amazonaws.glue#NullableInteger", + "traits": { + "smithy.api#documentation": "

The number of workers to use for the session.

" + } + }, + "WorkerType": { + "target": "com.amazonaws.glue#WorkerType", + "traits": { + "smithy.api#documentation": "

The Worker Type. Can be one of G.1X, G.2X, Standard

" + } + }, + "SecurityConfiguration": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the SecurityConfiguration structure to be used with the session

" + } + }, + "GlueVersion": { + "target": "com.amazonaws.glue#GlueVersionString", + "traits": { + "smithy.api#documentation": "

The Glue version determines the versions of Apache Spark and Python that AWS Glue supports. \n The GlueVersion must be greater than 2.0.

" + } + }, + "Tags": { + "target": "com.amazonaws.glue#TagsMap", + "traits": { + "smithy.api#documentation": "

The map of key value pairs (tags) belonging to the session.

" + } + }, + "RequestOrigin": { + "target": "com.amazonaws.glue#OrchestrationNameString", + "traits": { + "smithy.api#documentation": "

The origin of the request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Request to create a new session.

" + } + }, + "com.amazonaws.glue#CreateSessionResponse": { + "type": "structure", + "members": { + "Session": { + "target": "com.amazonaws.glue#Session", + "traits": { + "smithy.api#documentation": "

Returns the session object in the response.

" + } + } + } + }, "com.amazonaws.glue#CreateTable": { "type": "operation", "input": { @@ -7171,6 +7433,67 @@ "type": "structure", "members": {} }, + "com.amazonaws.glue#DeleteSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#DeleteSessionRequest" + }, + "output": { + "target": "com.amazonaws.glue#DeleteSessionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.glue#IllegalSessionStateException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the session.

" + } + }, + "com.amazonaws.glue#DeleteSessionRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The ID of the session to be deleted.

", + "smithy.api#required": {} + } + }, + "RequestOrigin": { + "target": "com.amazonaws.glue#OrchestrationNameString", + "traits": { + "smithy.api#documentation": "

The name of the origin of the delete session request.

" + } + } + } + }, + "com.amazonaws.glue#DeleteSessionResponse": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

Returns the ID of the deleted session.

" + } + } + } + }, "com.amazonaws.glue#DeleteTable": { "type": "operation", "input": { @@ -7744,6 +8067,9 @@ "smithy.api#documentation": "

Defines column statistics supported for floating-point number data columns.

" } }, + "com.amazonaws.glue#DoubleValue": { + "type": "double" + }, "com.amazonaws.glue#DynamoDBTarget": { "type": "structure", "members": { @@ -11218,10 +11544,136 @@ } } }, - "com.amazonaws.glue#GetTable": { + "com.amazonaws.glue#GetSession": { "type": "operation", "input": { - "target": "com.amazonaws.glue#GetTableRequest" + "target": "com.amazonaws.glue#GetSessionRequest" + }, + "output": { + "target": "com.amazonaws.glue#GetSessionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the session.

" + } + }, + "com.amazonaws.glue#GetSessionRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The ID of the session.

", + "smithy.api#required": {} + } + }, + "RequestOrigin": { + "target": "com.amazonaws.glue#OrchestrationNameString", + "traits": { + "smithy.api#documentation": "

The origin of the request.

" + } + } + } + }, + "com.amazonaws.glue#GetSessionResponse": { + "type": "structure", + "members": { + "Session": { + "target": "com.amazonaws.glue#Session", + "traits": { + "smithy.api#documentation": "

The session object is returned in the response.

" + } + } + } + }, + "com.amazonaws.glue#GetStatement": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#GetStatementRequest" + }, + "output": { + "target": "com.amazonaws.glue#GetStatementResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#IllegalSessionStateException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the statement.

" + } + }, + "com.amazonaws.glue#GetStatementRequest": { + "type": "structure", + "members": { + "SessionId": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The Session ID of the statement.

", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.glue#IntegerValue", + "traits": { + "smithy.api#documentation": "

The Id of the statement.

", + "smithy.api#required": {} + } + }, + "RequestOrigin": { + "target": "com.amazonaws.glue#OrchestrationNameString", + "traits": { + "smithy.api#documentation": "

The origin of the request.

" + } + } + } + }, + "com.amazonaws.glue#GetStatementResponse": { + "type": "structure", + "members": { + "Statement": { + "target": "com.amazonaws.glue#Statement", + "traits": { + "smithy.api#documentation": "

Returns the statement.

" + } + } + } + }, + "com.amazonaws.glue#GetTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#GetTableRequest" }, "output": { "target": "com.amazonaws.glue#GetTableResponse" @@ -12390,7 +12842,7 @@ "Message": { "target": "com.amazonaws.glue#MessageString", "traits": { - "smithy.api#documentation": "

A message describing the problem.

" + "smithy.api#documentation": "

The message describing the problem.

" } } }, @@ -12438,7 +12890,7 @@ "min": 1, "max": 10240 }, - "smithy.api#pattern": "^arn:aws:glue:" + "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn):glue:" } }, "com.amazonaws.glue#GlueTable": { @@ -12606,6 +13058,21 @@ "smithy.api#error": "client" } }, + "com.amazonaws.glue#IllegalSessionStateException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.glue#MessageString", + "traits": { + "smithy.api#documentation": "

A message describing the problem.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The session is in an invalid state to perform a requested operation.

", + "smithy.api#error": "client" + } + }, "com.amazonaws.glue#IllegalWorkflowStateException": { "type": "structure", "members": { @@ -14170,6 +14637,156 @@ } } }, + "com.amazonaws.glue#ListSessions": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#ListSessionsRequest" + }, + "output": { + "target": "com.amazonaws.glue#ListSessionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieve a session..

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.glue#ListSessionsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.glue#OrchestrationToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more result.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.glue#PageSize", + "traits": { + "smithy.api#documentation": "

The maximum number of results.

" + } + }, + "Tags": { + "target": "com.amazonaws.glue#TagsMap", + "traits": { + "smithy.api#documentation": "

Tags belonging to the session.

" + } + }, + "RequestOrigin": { + "target": "com.amazonaws.glue#OrchestrationNameString", + "traits": { + "smithy.api#documentation": "

The origin of the request.

" + } + } + } + }, + "com.amazonaws.glue#ListSessionsResponse": { + "type": "structure", + "members": { + "Ids": { + "target": "com.amazonaws.glue#SessionIdList", + "traits": { + "smithy.api#documentation": "

Returns the Id of the session.

" + } + }, + "Sessions": { + "target": "com.amazonaws.glue#SessionList", + "traits": { + "smithy.api#documentation": "

Returns the session object.

" + } + }, + "NextToken": { + "target": "com.amazonaws.glue#OrchestrationToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more result.

" + } + } + } + }, + "com.amazonaws.glue#ListStatements": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#ListStatementsRequest" + }, + "output": { + "target": "com.amazonaws.glue#ListStatementsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#IllegalSessionStateException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists statements for the session.

" + } + }, + "com.amazonaws.glue#ListStatementsRequest": { + "type": "structure", + "members": { + "SessionId": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The Session ID of the statements.

", + "smithy.api#required": {} + } + }, + "RequestOrigin": { + "target": "com.amazonaws.glue#OrchestrationNameString", + "traits": { + "smithy.api#documentation": "

The origin of the request to list statements.

" + } + }, + "NextToken": { + "target": "com.amazonaws.glue#OrchestrationToken" + } + } + }, + "com.amazonaws.glue#ListStatementsResponse": { + "type": "structure", + "members": { + "Statements": { + "target": "com.amazonaws.glue#StatementList", + "traits": { + "smithy.api#documentation": "

Returns the list of statements.

" + } + }, + "NextToken": { + "target": "com.amazonaws.glue#OrchestrationToken" + } + } + }, "com.amazonaws.glue#ListTriggers": { "type": "operation", "input": { @@ -14443,6 +15060,9 @@ "smithy.api#documentation": "

Defines column statistics supported for integer data columns.

" } }, + "com.amazonaws.glue#LongValue": { + "type": "long" + }, "com.amazonaws.glue#MLTransform": { "type": "structure", "members": { @@ -15024,6 +15644,31 @@ "smithy.api#error": "client" } }, + "com.amazonaws.glue#OrchestrationArgumentsMap": { + "type": "map", + "key": { + "target": "com.amazonaws.glue#OrchestrationNameString" + }, + "value": { + "target": "com.amazonaws.glue#OrchestrationArgumentsValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 75 + } + } + }, + "com.amazonaws.glue#OrchestrationArgumentsValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4096 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" + } + }, "com.amazonaws.glue#OrchestrationIAMRoleArn": { "type": "string", "traits": { @@ -15044,14 +15689,33 @@ "smithy.api#pattern": "^[\\.\\-_A-Za-z0-9]+$" } }, - "com.amazonaws.glue#OrchestrationS3Location": { + "com.amazonaws.glue#OrchestrationRoleArn": { "type": "string", "traits": { "smithy.api#length": { - "min": 1, - "max": 8192 + "min": 20, + "max": 2048 }, - "smithy.api#pattern": "^s3://([^/]+)/([^/]+/)*([^/]+)$" + "smithy.api#pattern": "^arn:aws[^:]*:iam::[0-9]*:role/.+$" + } + }, + "com.amazonaws.glue#OrchestrationS3Location": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 8192 + }, + "smithy.api#pattern": "^s3://([^/]+)/([^/]+/)*([^/]+)$" + } + }, + "com.amazonaws.glue#OrchestrationStatementCodeString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 68000 + } } }, "com.amazonaws.glue#OrchestrationStringList": { @@ -15060,6 +15724,15 @@ "target": "com.amazonaws.glue#GenericString" } }, + "com.amazonaws.glue#OrchestrationToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 400000 + } + } + }, "com.amazonaws.glue#Order": { "type": "structure", "members": { @@ -15528,8 +16201,7 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 2, - "max": 10240 + "min": 2 } } }, @@ -16626,6 +17298,80 @@ "com.amazonaws.glue#RunId": { "type": "string" }, + "com.amazonaws.glue#RunStatement": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#RunStatementRequest" + }, + "output": { + "target": "com.amazonaws.glue#RunStatementResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#IllegalSessionStateException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + }, + { + "target": "com.amazonaws.glue#ResourceNumberLimitExceededException" + }, + { + "target": "com.amazonaws.glue#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Executes the statement.

" + } + }, + "com.amazonaws.glue#RunStatementRequest": { + "type": "structure", + "members": { + "SessionId": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The Session Id of the statement to be run.

", + "smithy.api#required": {} + } + }, + "Code": { + "target": "com.amazonaws.glue#OrchestrationStatementCodeString", + "traits": { + "smithy.api#documentation": "

The statement code to be run.

", + "smithy.api#required": {} + } + }, + "RequestOrigin": { + "target": "com.amazonaws.glue#OrchestrationNameString", + "traits": { + "smithy.api#documentation": "

The origin of the request.

" + } + } + } + }, + "com.amazonaws.glue#RunStatementResponse": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.glue#IntegerValue", + "traits": { + "smithy.api#documentation": "

Returns the Id of the statement that was run.

" + } + } + } + }, "com.amazonaws.glue#S3Encryption": { "type": "structure", "members": { @@ -17165,7 +17911,13 @@ } }, "com.amazonaws.glue#ScriptLocationString": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 400000 + } + } }, "com.amazonaws.glue#SearchPropertyPredicates": { "type": "list", @@ -17357,6 +18109,155 @@ "smithy.api#documentation": "

Information about a serialization/deserialization program (SerDe) that serves as an\n extractor and loader.

" } }, + "com.amazonaws.glue#Session": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The ID of the session.

" + } + }, + "CreatedOn": { + "target": "com.amazonaws.glue#TimestampValue", + "traits": { + "smithy.api#documentation": "

The time and date when the session was created.

" + } + }, + "Status": { + "target": "com.amazonaws.glue#SessionStatus", + "traits": { + "smithy.api#documentation": "

The session status.

" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.glue#DescriptionString", + "traits": { + "smithy.api#documentation": "

The error message displayed during the session.

" + } + }, + "Description": { + "target": "com.amazonaws.glue#DescriptionString", + "traits": { + "smithy.api#documentation": "

The description of the session.

" + } + }, + "Role": { + "target": "com.amazonaws.glue#OrchestrationRoleArn", + "traits": { + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the IAM role associated with the Session.

" + } + }, + "Command": { + "target": "com.amazonaws.glue#SessionCommand", + "traits": { + "smithy.api#documentation": "

The command object.See SessionCommand.

" + } + }, + "DefaultArguments": { + "target": "com.amazonaws.glue#OrchestrationArgumentsMap", + "traits": { + "smithy.api#documentation": "

A map array of key-value pairs. Max is 75 pairs.

" + } + }, + "Connections": { + "target": "com.amazonaws.glue#ConnectionsList", + "traits": { + "smithy.api#documentation": "

The number of connections used for the session.

" + } + }, + "Progress": { + "target": "com.amazonaws.glue#DoubleValue", + "traits": { + "smithy.api#documentation": "

The code execution progress of the session.

" + } + }, + "MaxCapacity": { + "target": "com.amazonaws.glue#NullableDouble", + "traits": { + "smithy.api#documentation": "

The number of AWS Glue data processing units (DPUs) that can be allocated when the job runs. \n A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB memory.

" + } + }, + "SecurityConfiguration": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the SecurityConfiguration structure to be used with the session.

" + } + }, + "GlueVersion": { + "target": "com.amazonaws.glue#GlueVersionString", + "traits": { + "smithy.api#documentation": "

The Glue version determines the versions of Apache Spark and Python that AWS Glue supports. \n The GlueVersion must be greater than 2.0.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The period in which a remote Spark runtime environment is running.

" + } + }, + "com.amazonaws.glue#SessionCommand": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

Specifies the name of the SessionCommand.Can be 'glueetl' or 'gluestreaming'.

" + } + }, + "PythonVersion": { + "target": "com.amazonaws.glue#PythonVersionString", + "traits": { + "smithy.api#documentation": "

Specifies the Python version. The Python version indicates the version supported for jobs of type Spark.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The SessionCommand that runs the job.

" + } + }, + "com.amazonaws.glue#SessionIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#NameString" + } + }, + "com.amazonaws.glue#SessionList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#Session" + } + }, + "com.amazonaws.glue#SessionStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PROVISIONING", + "name": "PROVISIONING" + }, + { + "value": "READY", + "name": "READY" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "TIMEOUT", + "name": "TIMEOUT" + }, + { + "value": "STOPPING", + "name": "STOPPING" + }, + { + "value": "STOPPED", + "name": "STOPPED" + } + ] + } + }, "com.amazonaws.glue#SkewedInfo": { "type": "structure", "members": { @@ -18080,6 +18981,151 @@ "smithy.api#documentation": "

The batch condition that started the workflow run. Either the number of events in the batch size arrived,\n in which case the BatchSize member is non-zero, or the batch window expired, in which case the BatchWindow\n member is non-zero.

" } }, + "com.amazonaws.glue#Statement": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.glue#IntegerValue", + "traits": { + "smithy.api#documentation": "

The ID of the statement.

" + } + }, + "Code": { + "target": "com.amazonaws.glue#GenericString", + "traits": { + "smithy.api#documentation": "

The execution code of the statement.

" + } + }, + "State": { + "target": "com.amazonaws.glue#StatementState", + "traits": { + "smithy.api#documentation": "

The state while request is actioned.

" + } + }, + "Output": { + "target": "com.amazonaws.glue#StatementOutput", + "traits": { + "smithy.api#documentation": "

The output in JSON.

" + } + }, + "Progress": { + "target": "com.amazonaws.glue#DoubleValue", + "traits": { + "smithy.api#documentation": "

The code execution progress.

" + } + }, + "StartedOn": { + "target": "com.amazonaws.glue#LongValue", + "traits": { + "smithy.api#documentation": "

The unix time and date that the job definition was started.

" + } + }, + "CompletedOn": { + "target": "com.amazonaws.glue#LongValue", + "traits": { + "smithy.api#documentation": "

The unix time and date that the job definition was completed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The statement or request for a particular action to occur in a session.

" + } + }, + "com.amazonaws.glue#StatementList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#Statement" + } + }, + "com.amazonaws.glue#StatementOutput": { + "type": "structure", + "members": { + "Data": { + "target": "com.amazonaws.glue#StatementOutputData", + "traits": { + "smithy.api#documentation": "

The code execution output.

" + } + }, + "ExecutionCount": { + "target": "com.amazonaws.glue#IntegerValue", + "traits": { + "smithy.api#documentation": "

The execution count of the output.

" + } + }, + "Status": { + "target": "com.amazonaws.glue#StatementState", + "traits": { + "smithy.api#documentation": "

The status of the code execution output.

" + } + }, + "ErrorName": { + "target": "com.amazonaws.glue#GenericString", + "traits": { + "smithy.api#documentation": "

The name of the error in the output.

" + } + }, + "ErrorValue": { + "target": "com.amazonaws.glue#GenericString", + "traits": { + "smithy.api#documentation": "

The error value of the output.

" + } + }, + "Traceback": { + "target": "com.amazonaws.glue#OrchestrationStringList", + "traits": { + "smithy.api#documentation": "

The traceback of the output.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The code execution output in JSON format.

" + } + }, + "com.amazonaws.glue#StatementOutputData": { + "type": "structure", + "members": { + "TextPlain": { + "target": "com.amazonaws.glue#GenericString", + "traits": { + "smithy.api#documentation": "

The code execution output in text format.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The code execution output in JSON format.

" + } + }, + "com.amazonaws.glue#StatementState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "WAITING", + "name": "WAITING" + }, + { + "value": "RUNNING", + "name": "RUNNING" + }, + { + "value": "AVAILABLE", + "name": "AVAILABLE" + }, + { + "value": "CANCELLING", + "name": "CANCELLING" + }, + { + "value": "CANCELLED", + "name": "CANCELLED" + }, + { + "value": "ERROR", + "name": "ERROR" + } + ] + } + }, "com.amazonaws.glue#StopCrawler": { "type": "operation", "input": { @@ -18164,6 +19210,67 @@ "type": "structure", "members": {} }, + "com.amazonaws.glue#StopSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#StopSessionRequest" + }, + "output": { + "target": "com.amazonaws.glue#StopSessionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.glue#IllegalSessionStateException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "

Stops the session.

" + } + }, + "com.amazonaws.glue#StopSessionRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The ID of the session to be stopped.

", + "smithy.api#required": {} + } + }, + "RequestOrigin": { + "target": "com.amazonaws.glue#OrchestrationNameString", + "traits": { + "smithy.api#documentation": "

The origin of the request.

" + } + } + } + }, + "com.amazonaws.glue#StopSessionResponse": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

Returns the Id of the stopped session.

" + } + } + } + }, "com.amazonaws.glue#StopTrigger": { "type": "operation", "input": { diff --git a/codegen/sdk-codegen/aws-models/kendra.json b/codegen/sdk-codegen/aws-models/kendra.json index 3d21ae0aef9ac..b7f13b730f0d5 100644 --- a/codegen/sdk-codegen/aws-models/kendra.json +++ b/codegen/sdk-codegen/aws-models/kendra.json @@ -1178,12 +1178,12 @@ "AttachmentFieldMappings": { "target": "com.amazonaws.kendra#ConfluenceAttachmentFieldMappingsList", "traits": { - "smithy.api#documentation": "

Defines how attachment metadata fields should be mapped to index\n fields. Before you can map a field, you must first create an index\n field with a matching type using the console or the\n UpdateIndex API.

\n

If you specify the AttachentFieldMappings parameter,\n you must specify at least one field mapping.

" + "smithy.api#documentation": "

Maps attributes or field names of Confluence attachments to Amazon Kendra index field \n names. To create custom fields, use the UpdateIndex API before \n you map to Confluence fields. \n For more information, see Mapping data source fields. \n The Confluence data source field names must exist in your Confluence custom metadata.

\n

If you specify the AttachentFieldMappings parameter, you must specify \n at least one field mapping.

" } } }, "traits": { - "smithy.api#documentation": "

Specifies the attachment settings for the Confluence data source.\n Attachment settings are optional, if you don't specify settings\n attachments, Amazon Kendra won't index them.

" + "smithy.api#documentation": "

Configuration of attachment settings for the Confluence data source.\n Attachment settings are optional, if you don't specify settings\n attachments, Amazon Kendra won't index them.

" } }, "com.amazonaws.kendra#ConfluenceAttachmentFieldMappingsList": { @@ -1272,7 +1272,7 @@ } }, "traits": { - "smithy.api#documentation": "

Defines the mapping between a field in the Confluence data source\n to a Amazon Kendra index field.

\n

You must first create the index field using the\n UpdateIndex API.

" + "smithy.api#documentation": "

Maps attributes or field names of Confluence attachments to Amazon Kendra index field \n names. To create custom fields, use the UpdateIndex API before \n you map to Confluence fields. \n For more information, see Mapping data source fields. \n The Confuence data source field names must exist in your Confluence custom metadata.

" } }, "com.amazonaws.kendra#ConfluenceBlogConfiguration": { @@ -1281,12 +1281,12 @@ "BlogFieldMappings": { "target": "com.amazonaws.kendra#ConfluenceBlogFieldMappingsList", "traits": { - "smithy.api#documentation": "

Defines how blog metadata fields should be mapped to index fields.\n Before you can map a field, you must first create an index field\n with a matching type using the console or the\n UpdateIndex API.

\n

If you specify the BlogFieldMappings parameter, you\n must specify at least one field mapping.

" + "smithy.api#documentation": "

Maps attributes or field names of Confluence blogs to Amazon Kendra index field \n names. To create custom fields, use the UpdateIndex API before \n you map to Confluence fields. \n For more information, see Mapping data source fields. \n The Confluence data source field names must exist in your Confluence custom metadata.

\n

If you specify the BlogFieldMappings parameter, you\n must specify at least one field mapping.

" } } }, "traits": { - "smithy.api#documentation": "

Specifies the blog settings for the Confluence data source. Blogs\n are always indexed unless filtered from the index by the\n ExclusionPatterns or InclusionPatterns\n fields in the ConfluenceConfiguration object.

" + "smithy.api#documentation": "

Configuration of blog settings for the Confluence data source. Blogs\n are always indexed unless filtered from the index by the\n ExclusionPatterns or InclusionPatterns\n fields in the ConfluenceConfiguration object.

" } }, "com.amazonaws.kendra#ConfluenceBlogFieldMappingsList": { @@ -1367,7 +1367,7 @@ } }, "traits": { - "smithy.api#documentation": "

Defines the mapping between a blog field in the Confluence data\n source to a Amazon Kendra index field.

\n

You must first create the index field using the\n UpdateIndex API.

" + "smithy.api#documentation": "

Maps attributes or field names of Confluence blog to Amazon Kendra index field \n names. To create custom fields, use the UpdateIndex API before \n you map to Confluence fields. \n For more information, see Mapping data source fields. \n The Confluence data source field names must exist in your Confluence custom metadata.

" } }, "com.amazonaws.kendra#ConfluenceConfiguration": { @@ -1376,14 +1376,14 @@ "ServerUrl": { "target": "com.amazonaws.kendra#Url", "traits": { - "smithy.api#documentation": "

The URL of your Confluence instance. Use the full URL of the\n server. For example, https://server.example.com:port/.\n You can also use an IP address, for example,\n https://192.168.1.113/.

", + "smithy.api#documentation": "

The URL of your Confluence instance. Use the full URL of the\n server. For example, https://server.example.com:port/.\n You can also use an IP address, for example,\n https://192.168.1.113/.

", "smithy.api#required": {} } }, "SecretArn": { "target": "com.amazonaws.kendra#SecretArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Secrets Manager secret\n that contains the key/value pairs required to connect to your\n Confluence server. The secret must contain a JSON structure with the\n following keys:

\n ", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Secrets Manager secret\n that contains the key-value pairs required to connect to your\n Confluence server. The secret must contain a JSON structure with the\n following keys:

\n ", "smithy.api#required": {} } }, @@ -1397,43 +1397,43 @@ "SpaceConfiguration": { "target": "com.amazonaws.kendra#ConfluenceSpaceConfiguration", "traits": { - "smithy.api#documentation": "

Specifies configuration information for indexing Confluence\n spaces.

" + "smithy.api#documentation": "

Configuration information for indexing Confluence spaces.

" } }, "PageConfiguration": { "target": "com.amazonaws.kendra#ConfluencePageConfiguration", "traits": { - "smithy.api#documentation": "

Specifies configuration information for indexing Confluence\n pages.

" + "smithy.api#documentation": "

Configuration information for indexing Confluence pages.

" } }, "BlogConfiguration": { "target": "com.amazonaws.kendra#ConfluenceBlogConfiguration", "traits": { - "smithy.api#documentation": "

Specifies configuration information for indexing Confluence\n blogs.

" + "smithy.api#documentation": "

Configuration information for indexing Confluence blogs.

" } }, "AttachmentConfiguration": { "target": "com.amazonaws.kendra#ConfluenceAttachmentConfiguration", "traits": { - "smithy.api#documentation": "

Specifies configuration information for indexing attachments to\n Confluence blogs and pages.

" + "smithy.api#documentation": "

Configuration information for indexing attachments to\n Confluence blogs and pages.

" } }, "VpcConfiguration": { "target": "com.amazonaws.kendra#DataSourceVpcConfiguration", "traits": { - "smithy.api#documentation": "

Specifies the information for connecting to an Amazon VPC.

" + "smithy.api#documentation": "

Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence. \n For more information, see Configuring a VPC.

" } }, "InclusionPatterns": { "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", "traits": { - "smithy.api#documentation": "

A list of regular expression patterns that apply to a URL on the\n Confluence server. An inclusion pattern can apply to a blog post, a\n page, a space, or an attachment. Items that match the patterns are\n included in the index. Items that don't match the pattern are\n excluded from the index. If an item matches both an inclusion\n pattern and an exclusion pattern, the item isn't included in the\n index.

" + "smithy.api#documentation": "

A list of regular expression patterns to include certain blog posts, pages,\n spaces, or attachments in your Confluence. Content that matches the patterns are \n included in the index. Content that doesn't match the patterns is excluded from \n the index. If content matches both an inclusion and exclusion pattern, the \n exclusion pattern takes precedence and the content isn't included in the index.

" } }, "ExclusionPatterns": { "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", "traits": { - "smithy.api#documentation": "

A list of regular expression patterns that apply to a URL on the\n Confluence server. An exclusion pattern can apply to a blog post, a\n page, a space, or an attachment. Items that match the pattern are\n excluded from the index. Items that don't match the pattern are\n included in the index. If a item matches both an exclusion pattern\n and an inclusion pattern, the item isn't included in the\n index.

" + "smithy.api#documentation": "

>A list of regular expression patterns to exclude certain blog posts, pages,\n spaces, or attachments in your Confluence. Content that matches the patterns are \n excluded from the index. Content that doesn't match the patterns is included in \n the index. If content matches both an inclusion and exclusion pattern, the \n exclusion pattern takes precedence and the content isn't included in the index.

" } } }, @@ -1447,12 +1447,12 @@ "PageFieldMappings": { "target": "com.amazonaws.kendra#ConfluencePageFieldMappingsList", "traits": { - "smithy.api#documentation": "

Defines how page metadata fields should be mapped to index fields.\n Before you can map a field, you must first create an index field\n with a matching type using the console or the\n UpdateIndex API.

\n

If you specify the PageFieldMappings parameter, you\n must specify at least one field mapping.

" + "smithy.api#documentation": "

>Maps attributes or field names of Confluence pages to Amazon Kendra index field \n names. To create custom fields, use the UpdateIndex API before \n you map to Confluence fields. \n For more information, see Mapping data source fields. \n The Confluence data source field names must exist in your Confluence custom metadata.

\n

If you specify the PageFieldMappings parameter, you\n must specify at least one field mapping.

" } } }, "traits": { - "smithy.api#documentation": "

Specifies the page settings for the Confluence data source.

" + "smithy.api#documentation": "

Configuration of the page settings for the Confluence data source.

" } }, "com.amazonaws.kendra#ConfluencePageFieldMappingsList": { @@ -1528,7 +1528,7 @@ "DataSourceFieldName": { "target": "com.amazonaws.kendra#ConfluencePageFieldName", "traits": { - "smithy.api#documentation": "

The name of the field in the data source.

" + "smithy.api#documentation": "

The name of the field in the data source.

" } }, "DateFieldFormat": { @@ -1545,7 +1545,7 @@ } }, "traits": { - "smithy.api#documentation": "

Defines the mapping between a field in the Confluence data source\n to a Amazon Kendra index field.

\n

You must first create the index field using the\n UpdateIndex API.

" + "smithy.api#documentation": "

>Maps attributes or field names of Confluence pages to Amazon Kendra index field \n names. To create custom fields, use the UpdateIndex API before \n you map to Confluence fields. \n For more information, see Mapping data source fields. \n The Confluence data source field names must exist in your Confluence custom metadata.

" } }, "com.amazonaws.kendra#ConfluenceSpaceConfiguration": { @@ -1578,12 +1578,12 @@ "SpaceFieldMappings": { "target": "com.amazonaws.kendra#ConfluenceSpaceFieldMappingsList", "traits": { - "smithy.api#documentation": "

Defines how space metadata fields should be mapped to index\n fields. Before you can map a field, you must first create an index\n field with a matching type using the console or the\n UpdateIndex API.

\n

If you specify the SpaceFieldMappings parameter, you\n must specify at least one field mapping.

" + "smithy.api#documentation": "

Maps attributes or field names of Confluence spaces to Amazon Kendra index field \n names. To create custom fields, use the UpdateIndex API before \n you map to Confluence fields. \n For more information, see Mapping data source fields. \n The Confluence data source field names must exist in your Confluence custom metadata.

\n

If you specify the SpaceFieldMappings parameter, you\n must specify at least one field mapping.

" } } }, "traits": { - "smithy.api#documentation": "

Specifies the configuration for indexing Confluence spaces.

" + "smithy.api#documentation": "

Configuration information for indexing Confluence spaces.

" } }, "com.amazonaws.kendra#ConfluenceSpaceFieldMappingsList": { @@ -1665,7 +1665,7 @@ } }, "traits": { - "smithy.api#documentation": "

Defines the mapping between a field in the Confluence data source\n to an Amazon Kendra index field.

\n

You must first create the index field using the\n UpdateIndex API.

" + "smithy.api#documentation": "

>Maps attributes or field names of Confluence spaces to Amazon Kendra index field \n names. To create custom fields, use the UpdateIndex API before \n you map to Confluence fields. \n For more information, see Mapping data source fields. \n The Confluence data source field names must exist in your Confluence custom metadata.

" } }, "com.amazonaws.kendra#ConfluenceVersion": { @@ -2537,13 +2537,13 @@ "ConfluenceConfiguration": { "target": "com.amazonaws.kendra#ConfluenceConfiguration", "traits": { - "smithy.api#documentation": "

Provides configuration information for connecting to a Confluence\n data source.

" + "smithy.api#documentation": "

Provides the configuration information to connect to Confluence \n as your data source.

" } }, "GoogleDriveConfiguration": { "target": "com.amazonaws.kendra#GoogleDriveConfiguration", "traits": { - "smithy.api#documentation": "

Provides the configuration information to connect to Google\n Drive as your data source.

" + "smithy.api#documentation": "

Provides the configuration information to connect to Google\n Drive as your data source.

" } }, "WebCrawlerConfiguration": { @@ -2560,6 +2560,12 @@ "traits": { "smithy.api#documentation": "

Provides the configuration information to connect to Amazon FSx as \n your data source.

" } + }, + "SlackConfiguration": { + "target": "com.amazonaws.kendra#SlackConfiguration", + "traits": { + "smithy.api#documentation": "

Provides the configuration information to connect to Slack as your \n data source.

" + } } }, "traits": { @@ -3013,6 +3019,10 @@ { "value": "FSX", "name": "FSX" + }, + { + "value": "SLACK", + "name": "SLACK" } ] } @@ -5735,7 +5745,7 @@ "VpcConfiguration": { "target": "com.amazonaws.kendra#DataSourceVpcConfiguration", "traits": { - "smithy.api#documentation": "

Configuration information for connecting to an \n Amazon Virtual Private Cloud for your Amazon FSx. Your Amazon FSx \n instance must reside inside your VPC.

", + "smithy.api#documentation": "

Configuration information for an Amazon Virtual Private Cloud to connect \n to your Amazon FSx. Your Amazon FSx \n instance must reside inside your VPC.

", "smithy.api#required": {} } }, @@ -5748,13 +5758,13 @@ "InclusionPatterns": { "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", "traits": { - "smithy.api#documentation": "

A list of regular expression patterns to include certain files \n in your Amazon FSx file system. Files that match the patterns \n are included in the index. Files that don't match the patterns are \n excluded from the index. If a file matches both an inclusion pattern \n and an exclusion pattern, the exclusion pattern takes precedence\n and the file isn't included in the index.

" + "smithy.api#documentation": "

A list of regular expression patterns to include certain files \n in your Amazon FSx file system. Files that match the patterns \n are included in the index. Files that don't match the patterns are \n excluded from the index. If a file matches both an inclusion and \n exclusion pattern, the exclusion pattern takes precedence and the file \n isn't included in the index.

" } }, "ExclusionPatterns": { "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", "traits": { - "smithy.api#documentation": "

A list of regular expression patterns to exclude certain files \n in your Amazon FSx file system. Files that match the patterns \n are excluded from the index. Files that don’t match the patterns are \n included in the index. If a file matches both an inclusion pattern \n and an exclusion pattern, the exclusion pattern takes precedence \n and the file isn't included in the index.

" + "smithy.api#documentation": "

A list of regular expression patterns to exclude certain files \n in your Amazon FSx file system. Files that match the patterns \n are excluded from the index. Files that don't match the patterns are \n included in the index. If a file matches both an inclusion and exclusion \n pattern, the exclusion pattern takes precedence and the file isn't included \n in the index.

" } }, "FieldMappings": { @@ -5967,19 +5977,19 @@ "InclusionPatterns": { "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", "traits": { - "smithy.api#documentation": "

A list of regular expression patterns that apply to path on Google\n Drive. Items that match the pattern are included in the index from\n both shared drives and users' My Drives. Items that don't match the\n pattern are excluded from the index. If an item matches both an\n inclusion pattern and an exclusion pattern, it is excluded from the\n index.

" + "smithy.api#documentation": "

A list of regular expression patterns to include certain items in your \n Google Drive, including shared drives and users' My Drives. Items that \n match the patterns are included in the index. Items that\n don't match the patterns are excluded from the index. If an item matches both\n an inclusion and exclusion pattern, the exclusion pattern takes precedence and the \n item isn't included in the index.

" } }, "ExclusionPatterns": { "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", "traits": { - "smithy.api#documentation": "

A list of regular expression patterns that apply to the path on\n Google Drive. Items that match the pattern are excluded from the\n index from both shared drives and users' My Drives. Items that don't\n match the pattern are included in the index. If an item matches both\n an exclusion pattern and an inclusion pattern, it is excluded from\n the index.

" + "smithy.api#documentation": "

A list of regular expression patterns to exclude certain items in your \n Google Drive, including shared drives and users' My Drives. Items that \n match the patterns are excluded from the index. Items that\n don't match the patterns are included in the index. If an item matches both\n an inclusion and exclusion pattern, the exclusion pattern takes precedence and the \n item isn't included in the index.

" } }, "FieldMappings": { "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", "traits": { - "smithy.api#documentation": "

Defines mapping between a field in the Google Drive and a Amazon Kendra\n index field.

\n

If you are using the console, you can define index fields when\n creating the mapping. If you are using the API, you must first\n create the field using the UpdateIndex\n API.

" + "smithy.api#documentation": "

Maps Google Drive data source attributes or field names to Amazon Kendra index \n field names. To create custom fields, use the UpdateIndex API before \n you map to Google Drive fields. \n For more information, see Mapping data source fields. \n The Google Drive data source field names must exist in your Google Drive custom metadata.

" } }, "ExcludeMimeTypes": { @@ -7508,6 +7518,16 @@ "smithy.api#box": {} } }, + "com.amazonaws.kendra#LookBackPeriod": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 168 + } + } + }, "com.amazonaws.kendra#MaxContentSizePerPageInMegaBytes": { "type": "float", "traits": { @@ -7823,19 +7843,19 @@ "InclusionPatterns": { "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", "traits": { - "smithy.api#documentation": "

A list of regular expression patterns. Documents that match the\n pattern are included in the index. Documents that don't match the\n pattern are excluded from the index. If a document matches both an\n inclusion pattern and an exclusion pattern, the document is not\n included in the index.

\n

The exclusion pattern is applied to the file name.

" + "smithy.api#documentation": "

A list of regular expression patterns to include certain documents \n in your OneDrive. Documents that match the\n patterns are included in the index. Documents that don't match the\n patterns are excluded from the index. If a document matches both an\n inclusion and exclusion pattern, the exclusion pattern takes \n precedence and the document isn't included in the index.

\n

The pattern is applied to the file name.

" } }, "ExclusionPatterns": { "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", "traits": { - "smithy.api#documentation": "

List of regular expressions applied to documents. Items that match\n the exclusion pattern are not indexed. If you provide both an\n inclusion pattern and an exclusion pattern, any item that matches\n the exclusion pattern isn't indexed.

\n

The exclusion pattern is applied to the file name.

" + "smithy.api#documentation": "

A list of regular expression patterns to exclude certain documents \n in your OneDrive. Documents that match the\n patterns are excluded from the index. Documents that don't match the\n patterns are included in the index. If a document matches both an\n inclusion and exclusion pattern, the exclusion pattern takes \n precedence and the document isn't included in the index.

\n

The pattern is applied to the file name.

" } }, "FieldMappings": { "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", "traits": { - "smithy.api#documentation": "

A list of DataSourceToIndexFieldMapping objects that\n map Microsoft OneDrive fields to custom fields in the Amazon Kendra\n index. You must first create the index fields before you map\n OneDrive fields.

" + "smithy.api#documentation": "

A list of DataSourceToIndexFieldMapping objects that map OneDrive data \n source attributes or field names to Amazon Kendra index field names. To create \n custom fields, use the UpdateIndex API before you map to OneDrive fields. \n For more information, see Mapping data source fields. \n The OneDrive data source field names must exist in your OneDrive custom metadata.

" } }, "DisableLocalGroups": { @@ -8082,6 +8102,12 @@ ] } }, + "com.amazonaws.kendra#PrivateChannelFilter": { + "type": "list", + "member": { + "target": "com.amazonaws.kendra#String" + } + }, "com.amazonaws.kendra#ProxyConfiguration": { "type": "structure", "members": { @@ -8110,6 +8136,12 @@ "smithy.api#documentation": "

Provides the configuration information for a web proxy to connect to \n website hosts.

" } }, + "com.amazonaws.kendra#PublicChannelFilter": { + "type": "list", + "member": { + "target": "com.amazonaws.kendra#String" + } + }, "com.amazonaws.kendra#PutPrincipalMapping": { "type": "operation", "input": { @@ -8937,19 +8969,19 @@ "StandardObjectConfigurations": { "target": "com.amazonaws.kendra#SalesforceStandardObjectConfigurationList", "traits": { - "smithy.api#documentation": "

Specifies the Salesforce standard objects that Amazon Kendra\n indexes.

" + "smithy.api#documentation": "

Configuration of the Salesforce standard objects that Amazon Kendra\n indexes.

" } }, "KnowledgeArticleConfiguration": { "target": "com.amazonaws.kendra#SalesforceKnowledgeArticleConfiguration", "traits": { - "smithy.api#documentation": "

Specifies configuration information for the knowledge article\n types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge\n articles and the standard fields of knowledge articles, or the\n custom fields of custom knowledge articles, but not both.

" + "smithy.api#documentation": "

Configuration information for the knowledge article\n types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge\n articles and the standard fields of knowledge articles, or the\n custom fields of custom knowledge articles, but not both.

" } }, "ChatterFeedConfiguration": { "target": "com.amazonaws.kendra#SalesforceChatterFeedConfiguration", "traits": { - "smithy.api#documentation": "

Specifies configuration information for Salesforce chatter\n feeds.

" + "smithy.api#documentation": "

Configuration information for Salesforce chatter feeds.

" } }, "CrawlAttachments": { @@ -8967,18 +8999,18 @@ "IncludeAttachmentFilePatterns": { "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", "traits": { - "smithy.api#documentation": "

A list of regular expression patterns. Documents that match the\n patterns are included in the index. Documents that don't match the\n patterns are excluded from the index. If a document matches both an\n inclusion pattern and an exclusion pattern, the document is not\n included in the index.

\n

The regex is applied to the name of the attached file.

" + "smithy.api#documentation": "

A list of regular expression patterns to include certain documents in your Salesforce.\n Documents that match the patterns are included in the index. Documents that\n don't match the patterns are excluded from the index. If a document matches both\n an inclusion and exclusion pattern, the exclusion pattern takes precedence and the \n document isn't included in the index.

\n

The pattern is applied to the name of the attached file.

" } }, "ExcludeAttachmentFilePatterns": { "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", "traits": { - "smithy.api#documentation": "

A list of regular expression patterns. Documents that match the\n patterns are excluded from the index. Documents that don't match the\n patterns are included in the index. If a document matches both an\n exclusion pattern and an inclusion pattern, the document is not\n included in the index.

\n

The regex is applied to the name of the attached file.

" + "smithy.api#documentation": "

A list of regular expression patterns to exclude certain documents in your Salesforce.\n Documents that match the patterns are excluded from the index. Documents that\n don't match the patterns are included in the index. If a document matches both\n an inclusion and exclusion pattern, the exclusion pattern takes precedence and the \n document isn't included in the index.

\n

The pattern is applied to the name of the attached file.

" } } }, "traits": { - "smithy.api#documentation": "

Provides configuration information for connecting to a Salesforce\n data source.

" + "smithy.api#documentation": "

Provides the configuration information to connect to Salesforce\n as your data source.

" } }, "com.amazonaws.kendra#SalesforceCustomKnowledgeArticleTypeConfiguration": { @@ -9007,12 +9039,12 @@ "FieldMappings": { "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", "traits": { - "smithy.api#documentation": "

One or more objects that map fields in the custom knowledge\n article to fields in the Amazon Kendra index.

" + "smithy.api#documentation": "

Maps attributes or field names of the custom knowledge article to Amazon Kendra \n index field names. To create custom fields, use the UpdateIndex API \n before you map to Salesforce fields. \n For more information, see Mapping data source fields. \n The Salesforce data source field names must exist in your Salesforce custom metadata.

" } } }, "traits": { - "smithy.api#documentation": "

Provides configuration information for indexing Salesforce custom\n articles.

" + "smithy.api#documentation": "

Provides the configuration information for indexing Salesforce custom\n articles.

" } }, "com.amazonaws.kendra#SalesforceCustomKnowledgeArticleTypeConfigurationList": { @@ -9114,12 +9146,12 @@ "FieldMappings": { "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", "traits": { - "smithy.api#documentation": "

One or more objects that map fields in the knowledge article to\n Amazon Kendra index fields. The index field must exist before you can map\n a Salesforce field to it.

" + "smithy.api#documentation": "

Maps attributes or field names of the knowledge article to Amazon Kendra \n index field names. To create custom fields, use the UpdateIndex API \n before you map to Salesforce fields. \n For more information, see Mapping data source fields. \n The Salesforce data source field names must exist in your Salesforce custom metadata.

" } } }, "traits": { - "smithy.api#documentation": "

Configuration information for standard Salesforce\n knowledge articles.

" + "smithy.api#documentation": "

Provides the configuration information for standard Salesforce\n knowledge articles.

" } }, "com.amazonaws.kendra#SalesforceStandardObjectAttachmentConfiguration": { @@ -9139,7 +9171,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides the configuration information for processing attachments to\n Salesforce standard objects.

" + "smithy.api#documentation": "

Provides the configuration information for processing attachments to\n Salesforce standard objects.

" } }, "com.amazonaws.kendra#SalesforceStandardObjectConfiguration": { @@ -9168,7 +9200,7 @@ "FieldMappings": { "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", "traits": { - "smithy.api#documentation": "

One or more objects that map fields in the standard object to\n Amazon Kendra index fields. The index field must exist before you can map\n a Salesforce field to it.

" + "smithy.api#documentation": "

Maps attributes or field names of the standard object to Amazon Kendra \n index field names. To create custom fields, use the UpdateIndex API \n before you map to Salesforce fields. \n For more information, see Mapping data source fields. \n The Salesforce data source field names must exist in your Salesforce custom metadata.

" } } }, @@ -9455,7 +9487,7 @@ "HostUrl": { "target": "com.amazonaws.kendra#ServiceNowHostUrl", "traits": { - "smithy.api#documentation": "

The ServiceNow instance that the data source connects to. The host\n endpoint should look like the following:\n {instance}.service-now.com.\n

", + "smithy.api#documentation": "

The ServiceNow instance that the data source connects to. The host\n endpoint should look like the following:\n {instance}.service-now.com.\n

", "smithy.api#required": {} } }, @@ -9488,7 +9520,7 @@ "AuthenticationType": { "target": "com.amazonaws.kendra#ServiceNowAuthenticationType", "traits": { - "smithy.api#documentation": "

Determines the type of authentication used to connect to the\n ServiceNow instance. If you choose HTTP_BASIC, Amazon Kendra is\n authenticated using the user name and password provided in the \n Secrets Manager secret in the SecretArn field. When you\n choose OAUTH2, Amazon Kendra is authenticated using the OAuth\n token and secret provided in the Secrets Manager secret, and the\n user name and password are used to determine which information Amazon Kendra\n has access to.

\n

When you use OAUTH2 authentication, you must generate\n a token and a client secret using the ServiceNow console. For more\n information, see Using a\n ServiceNow data source.

" + "smithy.api#documentation": "

The type of authentication used to connect to the\n ServiceNow instance. If you choose HTTP_BASIC, Amazon Kendra is\n authenticated using the user name and password provided in the \n Secrets Manager secret in the SecretArn field. When you\n choose OAUTH2, Amazon Kendra is authenticated using the OAuth\n token and secret provided in the Secrets Manager secret, and the\n user name and password are used to determine which information Amazon Kendra\n has access to.

\n

When you use OAUTH2 authentication, you must generate\n a token and a client secret using the ServiceNow console. For more\n information, see Using a\n ServiceNow data source.

" } } }, @@ -9518,13 +9550,13 @@ "IncludeAttachmentFilePatterns": { "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", "traits": { - "smithy.api#documentation": "

List of regular expressions applied to knowledge articles. Items\n that don't match the inclusion pattern are not indexed. The regex is\n applied to the field specified in the\n PatternTargetField.

" + "smithy.api#documentation": "

A list of regular expression patterns to include certain attachments of knowledge articles in \n your ServiceNow. Item that match the patterns are included in the index. Items that\n don't match the patterns are excluded from the index. If an item matches both\n an inclusion and exclusion pattern, the exclusion pattern takes precedence and the \n item isn't included in the index.

\n

The regex is\n applied to the field specified in the PatternTargetField.

" } }, "ExcludeAttachmentFilePatterns": { "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", "traits": { - "smithy.api#documentation": "

List of regular expressions applied to knowledge articles. Items\n that don't match the inclusion pattern are not indexed. The regex is\n applied to the field specified in the\n PatternTargetField\n

" + "smithy.api#documentation": "

A list of regular expression patterns to exclude certain attachments of knowledge articles in \n your ServiceNow. Item that match the patterns are excluded from the index. Items that\n don't match the patterns are included in the index. If an item matches both\n an inclusion and exclusion pattern, the exclusion pattern takes precedence and the \n item isn't included in the index.

\n

The regex is\n applied to the field specified in the PatternTargetField.

" } }, "DocumentDataFieldName": { @@ -9543,7 +9575,7 @@ "FieldMappings": { "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", "traits": { - "smithy.api#documentation": "

Mapping between ServiceNow fields and Amazon Kendra index fields. You\n must create the index field before you map the field.

" + "smithy.api#documentation": "

Maps attributes or field names of knoweldge articles to Amazon Kendra index \n field names. To create custom fields, use the UpdateIndex API before \n you map to ServiceNow fields. \n For more information, see Mapping data source fields. \n The ServiceNow data source field names must exist in your ServiceNow custom metadata.

" } }, "FilterQuery": { @@ -9579,13 +9611,13 @@ "IncludeAttachmentFilePatterns": { "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", "traits": { - "smithy.api#documentation": "

A list of regular expression patterns. Documents that match the\n patterns are included in the index. Documents that don't match the\n patterns are excluded from the index. If a document matches both an\n exclusion pattern and an inclusion pattern, the document is not\n included in the index.

\n

The regex is applied to the file name of the attachment.

" + "smithy.api#documentation": "

A list of regular expression patterns to include certain attachments of catalogs in \n your ServiceNow. Item that match the patterns are included in the index. Items that\n don't match the patterns are excluded from the index. If an item matches both\n an inclusion and exclusion pattern, the exclusion pattern takes precedence and the \n item isn't included in the index.

\n

The regex is applied to the file name of the attachment.

" } }, "ExcludeAttachmentFilePatterns": { "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", "traits": { - "smithy.api#documentation": "

A list of regular expression patterns. Documents that match the\n patterns are excluded from the index. Documents that don't match the\n patterns are included in the index. If a document matches both an\n exclusion pattern and an inclusion pattern, the document is not\n included in the index.

\n

The regex is applied to the file name of the attachment.

" + "smithy.api#documentation": "

A list of regular expression patterns to exclude certain attachments of catalogs in \n your ServiceNow. Item that match the patterns are excluded from the index. Items that\n don't match the patterns are included in the index. If an item matches both\n an inclusion and exclusion pattern, the exclusion pattern takes precedence and the \n item isn't included in the index.

\n

The regex is applied to the file name of the attachment.

" } }, "DocumentDataFieldName": { @@ -9604,7 +9636,7 @@ "FieldMappings": { "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", "traits": { - "smithy.api#documentation": "

Mapping between ServiceNow fields and Amazon Kendra index fields. You\n must create the index field before you map the field.

" + "smithy.api#documentation": "

Maps attributes or field names of catalogs to Amazon Kendra index \n field names. To create custom fields, use the UpdateIndex API before \n you map to ServiceNow fields. \n For more information, see Mapping data source fields. \n The ServiceNow data source field names must exist in your ServiceNow custom metadata.

" } } }, @@ -9658,19 +9690,19 @@ "UseChangeLog": { "target": "com.amazonaws.kendra#Boolean", "traits": { - "smithy.api#documentation": "

Set to TRUE to use the Microsoft SharePoint change\n log to determine the documents that need to be updated in the index.\n Depending on the size of the SharePoint change log, it may take\n longer for Amazon Kendra to use the change log than it takes it to\n determine the changed documents using the Amazon Kendra document\n crawler.

" + "smithy.api#documentation": "

\n TRUE to use the SharePoint change log to determine which documents\n require updating in the index. Depending on the change log's\n size, it may take longer for Amazon Kendra to use the change log than to \n scan all of your documents in SharePoint.

" } }, "InclusionPatterns": { "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", "traits": { - "smithy.api#documentation": "

A list of regular expression patterns. Documents that match the\n patterns are included in the index. Documents that don't match the\n patterns are excluded from the index. If a document matches both an\n inclusion pattern and an exclusion pattern, the document is not\n included in the index.

\n

The regex is applied to the display URL of the SharePoint\n document.

" + "smithy.api#documentation": "

A list of regular expression patterns to include certain documents in your SharePoint.\n Documents that match the patterns are included in the index. Documents that\n don't match the patterns are excluded from the index. If a document matches both\n an inclusion and exclusion pattern, the exclusion pattern takes precedence and the \n document isn't included in the index.

\n

The regex is applied to the display URL of the SharePoint\n document.

" } }, "ExclusionPatterns": { "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", "traits": { - "smithy.api#documentation": "

A list of regular expression patterns. Documents that match the\n patterns are excluded from the index. Documents that don't match the\n patterns are included in the index. If a document matches both an\n exclusion pattern and an inclusion pattern, the document is not\n included in the index.

\n

The regex is applied to the display URL of the SharePoint\n document.

" + "smithy.api#documentation": "

A list of regular expression patterns to exclude certain documents in your SharePoint.\n Documents that match the patterns are excluded from the index. Documents that\n don't match the patterns are included in the index. If a document matches both\n an inclusion and exclusion pattern, the exclusion pattern takes precedence and the \n document isn't included in the index.

\n

The regex is applied to the display URL of the SharePoint\n document.

" } }, "VpcConfiguration": { @@ -9679,7 +9711,7 @@ "FieldMappings": { "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", "traits": { - "smithy.api#documentation": "

A list of DataSourceToIndexFieldMapping objects that\n map Microsoft SharePoint attributes to custom fields in the Amazon Kendra\n index. You must first create the index fields using the\n UpdateIndex API before you map SharePoint\n attributes. For more information, see Mapping Data Source\n Fields.

" + "smithy.api#documentation": "

A list of DataSourceToIndexFieldMapping objects that map SharePoint data \n source attributes or field names to Amazon Kendra index field names. To create \n custom fields, use the UpdateIndex API before you map to SharePoint fields. \n For more information, see Mapping data source fields. \n The SharePoint data source field names must exist in your SharePoint custom metadata.

" } }, "DocumentTitleFieldName": { @@ -9743,6 +9775,16 @@ "smithy.api#pattern": "^\\P{C}*$" } }, + "com.amazonaws.kendra#SinceCrawlDate": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 10 + }, + "smithy.api#pattern": "^(20\\d{2})-(0?[1-9]|1[0-2])-(0?[1-9]|1\\d|2\\d|3[01])$" + } + }, "com.amazonaws.kendra#SiteMap": { "type": "string", "traits": { @@ -9780,6 +9822,137 @@ } } }, + "com.amazonaws.kendra#SlackConfiguration": { + "type": "structure", + "members": { + "TeamId": { + "target": "com.amazonaws.kendra#TeamId", + "traits": { + "smithy.api#documentation": "

The identifier of the team in the Slack workspace. For example, \n T0123456789.

\n

You can find your team ID in the URL of the main page of your Slack workspace. \n When you log in to Slack via a browser, you are directed to the URL of the main \n page. For example, https://app.slack.com/client/T0123456789/....

", + "smithy.api#required": {} + } + }, + "SecretArn": { + "target": "com.amazonaws.kendra#SecretArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains \n the key-value pairs required to connect to your Slack workspace team. The secret \n must contain a JSON structure with the following keys:

\n ", + "smithy.api#required": {} + } + }, + "VpcConfiguration": { + "target": "com.amazonaws.kendra#DataSourceVpcConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration information for an Amazon Virtual Private Cloud to connect to your Slack. \n For more information, see Configuring a VPC.

" + } + }, + "SlackEntityList": { + "target": "com.amazonaws.kendra#SlackEntityList", + "traits": { + "smithy.api#documentation": "

Specify whether to index public channels, private channels, group messages, and \n direct messages. You can specify one or more of these options.

", + "smithy.api#required": {} + } + }, + "UseChangeLog": { + "target": "com.amazonaws.kendra#Boolean", + "traits": { + "smithy.api#documentation": "

\n TRUE to use the Slack change log to determine which documents\n require updating in the index. Depending on the Slack change log's\n size, it may take longer for Amazon Kendra to use the change log than to \n scan all of your documents in Slack.

" + } + }, + "CrawlBotMessage": { + "target": "com.amazonaws.kendra#Boolean", + "traits": { + "smithy.api#documentation": "

\n TRUE to index bot messages from your Slack workspace team.

" + } + }, + "ExcludeArchived": { + "target": "com.amazonaws.kendra#Boolean", + "traits": { + "smithy.api#documentation": "

\n TRUE to exclude archived messages to index from your Slack \n workspace team.

" + } + }, + "SinceCrawlDate": { + "target": "com.amazonaws.kendra#SinceCrawlDate", + "traits": { + "smithy.api#documentation": "

The date to start crawling your data from your Slack workspace team. The date \n must follow this format: yyyy-mm-dd.

", + "smithy.api#required": {} + } + }, + "LookBackPeriod": { + "target": "com.amazonaws.kendra#LookBackPeriod", + "traits": { + "smithy.api#documentation": "

The number of hours for change log to look back from when you last synchronized \n your data. You can look back up to 7 days or 168 hours.

\n

Change log updates your index only if new content was added since you\n last synced your data. Updated or deleted content from before you last synced\n does not get updated in your index. To capture updated or deleted content before you\n last synced, set the LookBackPeriod to the number of hours you want \n change log to look back.

" + } + }, + "PrivateChannelFilter": { + "target": "com.amazonaws.kendra#PrivateChannelFilter", + "traits": { + "smithy.api#documentation": "

The list of private channel names from your Slack workspace team. You use this if \n you want to index specific private channels, not all private channels. You can also \n use regular expression patterns to filter private channels.

" + } + }, + "PublicChannelFilter": { + "target": "com.amazonaws.kendra#PublicChannelFilter", + "traits": { + "smithy.api#documentation": "

The list of public channel names to index from your Slack workspace team. You use \n this if you want to index specific public channels, not all public channels. You can \n also use regular expression patterns to filter public channels.

" + } + }, + "InclusionPatterns": { + "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", + "traits": { + "smithy.api#documentation": "

A list of regular expression patterns to include certain attached files in your Slack\n workspace team. Files that match the patterns are included in the index. Files that\n don't match the patterns are excluded from the index. If a file matches both\n an inclusion and exclusion pattern, the exclusion pattern takes precedence and the \n file isn't included in the index.

" + } + }, + "ExclusionPatterns": { + "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", + "traits": { + "smithy.api#documentation": "

A list of regular expression patterns to exclude certain attached files in your Slack\n workspace team. Files that match the patterns are excluded from the index. Files that\n don’t match the patterns are included in the index. If a file matches both\n an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file \n isn't included in the index.

" + } + }, + "FieldMappings": { + "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", + "traits": { + "smithy.api#documentation": "

A list of DataSourceToIndexFieldMapping objects that map Slack data \n source attributes or field names to Amazon Kendra index field names. To create \n custom fields, use the UpdateIndex API before you map to Slack fields. \n For more information, see Mapping data source fields. \n The Slack data source field names must exist in your Slack custom metadata.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides the configuration information to connect to Slack as your \n data source.

" + } + }, + "com.amazonaws.kendra#SlackEntity": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PUBLIC_CHANNEL", + "name": "PUBLIC_CHANNEL" + }, + { + "value": "PRIVATE_CHANNEL", + "name": "PRIVATE_CHANNEL" + }, + { + "value": "GROUP_MESSAGE", + "name": "GROUP_MESSAGE" + }, + { + "value": "DIRECT_MESSAGE", + "name": "DIRECT_MESSAGE" + } + ] + } + }, + "com.amazonaws.kendra#SlackEntityList": { + "type": "list", + "member": { + "target": "com.amazonaws.kendra#SlackEntity" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4 + } + } + }, "com.amazonaws.kendra#SnapshotsDataHeaderFields": { "type": "list", "member": { @@ -10359,6 +10532,16 @@ } } }, + "com.amazonaws.kendra#TeamId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[A-Z0-9]*$" + } + }, "com.amazonaws.kendra#TenantDomain": { "type": "string", "traits": { @@ -11397,13 +11580,13 @@ "UrlInclusionPatterns": { "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", "traits": { - "smithy.api#documentation": "

The regular expression pattern to include certain URLs to crawl.

\n

If there is a regular expression pattern to exclude certain URLs that \n conflicts with the include pattern, the exclude pattern takes precedence.

" + "smithy.api#documentation": "

A list of regular expression patterns to include certain URLs to crawl. URLs \n that match the patterns are included in the index. URLs that\n don't match the patterns are excluded from the index. If a URL matches both\n an inclusion and exclusion pattern, the exclusion pattern takes precedence and the \n URL file isn't included in the index.

" } }, "UrlExclusionPatterns": { "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", "traits": { - "smithy.api#documentation": "

The regular expression pattern to exclude certain URLs to crawl.

\n

If there is a regular expression pattern to include certain URLs that \n conflicts with the exclude pattern, the exclude pattern takes precedence.

" + "smithy.api#documentation": "

A list of regular expression patterns to exclude certain URLs to crawl. URLs \n that match the patterns are excluded from the index. URLs that\n don't match the patterns are included in the index. If a URL matches both\n an inclusion and exclusion pattern, the exclusion pattern takes precedence and the \n URL file isn't included in the index.

" } }, "ProxyConfiguration": { @@ -11461,25 +11644,25 @@ "UseChangeLog": { "target": "com.amazonaws.kendra#Boolean", "traits": { - "smithy.api#documentation": "

\n TRUE to use the change logs to update documents in your \n index instead of scanning all documents.

\n

If you are syncing your Amazon WorkDocs data source with your index for the \n first time, all documents are scanned. After your first sync, you can \n use the change logs to update your documents in your index for \n future syncs.

\n

The default is set to FALSE.

" + "smithy.api#documentation": "

\n TRUE to use the Amazon WorkDocs change log to determine \n which documents require updating in the index. Depending on the change log's\n size, it may take longer for Amazon Kendra to use the change log than to \n scan all of your documents in Amazon WorkDocs.

" } }, "InclusionPatterns": { "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", "traits": { - "smithy.api#documentation": "

A list of regular expression patterns to include certain files \n in your Amazon WorkDocs site repository. Files that match the patterns \n are included in the index. Files that don't match the patterns are \n excluded from the index. If a file matches both an inclusion pattern \n and an exclusion pattern, the exclusion pattern takes precedence and \n the file isn’t included in the index.

" + "smithy.api#documentation": "

A list of regular expression patterns to include certain files \n in your Amazon WorkDocs site repository. Files that match the patterns \n are included in the index. Files that don't match the patterns are \n excluded from the index. If a file matches both an inclusion and exclusion \n pattern, the exclusion pattern takes precedence and the file isn't included \n in the index.

" } }, "ExclusionPatterns": { "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", "traits": { - "smithy.api#documentation": "

A list of regular expression patterns to exclude certain files \n in your Amazon WorkDocs site repository. Files that match the patterns \n are excluded from the index. Files that don’t match the patterns \n are included in the index. If a file matches both an inclusion \n pattern and an exclusion pattern, the exclusion pattern takes \n precedence and the file isn’t included in the index.

" + "smithy.api#documentation": "

A list of regular expression patterns to exclude certain files \n in your Amazon WorkDocs site repository. Files that match the patterns \n are excluded from the index. Files that don’t match the patterns \n are included in the index. If a file matches both an inclusion and exclusion \n pattern, the exclusion pattern takes precedence and the file isn't included \n in the index.

" } }, "FieldMappings": { "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", "traits": { - "smithy.api#documentation": "

A list of DataSourceToIndexFieldMapping objects that map \n Amazon WorkDocs field names to custom index field names in Amazon Kendra. You must first \n create the custom index fields using the UpdateIndex API before \n you map to Amazon WorkDocs fields. For more information, see \n Mapping \n Data Source Fields. The Amazon WorkDocs data source field names \n need to exist in your Amazon WorkDocs custom metadata.

" + "smithy.api#documentation": "

A list of DataSourceToIndexFieldMapping objects that \n map Amazon WorkDocs data source attributes or field names to Amazon Kendra \n index field names. To create custom fields, use the \n UpdateIndex API before you map to Amazon WorkDocs fields. \n For more information, see Mapping \n data source fields. The Amazon WorkDocs data source field names \n must exist in your Amazon WorkDocs custom metadata.

" } } }, diff --git a/codegen/sdk-codegen/aws-models/keyspaces.json b/codegen/sdk-codegen/aws-models/keyspaces.json index d7cc8b53a302d..5de7fd161b1ed 100644 --- a/codegen/sdk-codegen/aws-models/keyspaces.json +++ b/codegen/sdk-codegen/aws-models/keyspaces.json @@ -34,7 +34,7 @@ "throughputMode": { "target": "com.amazonaws.keyspaces#ThroughputMode", "traits": { - "smithy.api#documentation": "

The read/write throughput capacity mode for a table. The options are:

\n \n

The default is throughput_mode:PAY_PER_REQUEST.

\n

For more information, see Read/write capacity modes in the Amazon Keyspaces Developer\n Guide.

", + "smithy.api#documentation": "

The read/write throughput capacity mode for a table. The options are:

\n

• throughputMode:PAY_PER_REQUEST and

\n

• throughputMode:PROVISIONED - Provisioned capacity mode requires\n readCapacityUnits and writeCapacityUnits as input.

\n

The default is throughput_mode:PAY_PER_REQUEST.

\n

For more information, see Read/write capacity modes in the Amazon Keyspaces Developer\n Guide.

", "smithy.api#required": {} } }, @@ -52,7 +52,7 @@ } }, "traits": { - "smithy.api#documentation": "

Amazon Keyspaces has two read/write capacity modes for processing reads and writes on your tables:

\n \n \n

The read/write capacity mode that you choose controls how you are charged for read and\n write throughput and how table throughput capacity is managed.

\n

For more information, see Read/write capacity modes in the Amazon Keyspaces Developer\n Guide.

" + "smithy.api#documentation": "

Amazon Keyspaces has two read/write capacity modes for processing reads and writes on your tables:

\n

• On-demand (default)

\n

• Provisioned

\n

The read/write capacity mode that you choose controls how you are charged for read and\n write throughput and how table throughput capacity is managed.

\n

For more information, see Read/write capacity modes in the Amazon Keyspaces Developer\n Guide.

" } }, "com.amazonaws.keyspaces#CapacitySpecificationSummary": { @@ -61,7 +61,7 @@ "throughputMode": { "target": "com.amazonaws.keyspaces#ThroughputMode", "traits": { - "smithy.api#documentation": "

The read/write throughput capacity mode for a table. The options are:

\n \n

The default is throughput_mode:PAY_PER_REQUEST.

\n

For more information, see Read/write capacity modes in the Amazon Keyspaces Developer\n Guide.

", + "smithy.api#documentation": "

The read/write throughput capacity mode for a table. The options are:

\n

• throughputMode:PAY_PER_REQUEST and

\n

• throughputMode:PROVISIONED - Provisioned capacity mode requires\n readCapacityUnits and writeCapacityUnits as input.

\n

The default is throughput_mode:PAY_PER_REQUEST.

\n

For more information, see Read/write capacity modes in the Amazon Keyspaces Developer\n Guide.

", "smithy.api#required": {} } }, @@ -85,7 +85,7 @@ } }, "traits": { - "smithy.api#documentation": "

The read/write throughput capacity mode for a table. The options are:

\n \n

For more information, see Read/write capacity modes in the Amazon Keyspaces Developer\n Guide.

" + "smithy.api#documentation": "

The read/write throughput capacity mode for a table. The options are:

\n

• throughputMode:PAY_PER_REQUEST and

\n

• throughputMode:PROVISIONED.

\n

For more information, see Read/write capacity modes in the Amazon Keyspaces Developer\n Guide.

" } }, "com.amazonaws.keyspaces#CapacityUnits": { @@ -216,7 +216,7 @@ } ], "traits": { - "smithy.api#documentation": "

The CreateKeyspace operation adds a new keyspace to your account. In an Amazon Web Services account, keyspace names\n must be unique within each Region.

\n

\n CreateKeyspace is an asynchronous operation. You can monitor the creation status of the new keyspace \n by using the GetKeyspace operation.

\n

For more information, see Creating keyspaces in the Amazon Keyspaces Developer\n Guide.

" + "smithy.api#documentation": "

The CreateKeyspace operation adds a new keyspace to your account. In an Amazon Web Services account, keyspace names\n must be unique within each Region.

\n

\n CreateKeyspace is an asynchronous operation. You can monitor the creation status of the new keyspace \n by using the GetKeyspace operation.

\n

For more information, see Creating keyspaces in the Amazon Keyspaces Developer\n Guide.

" } }, "com.amazonaws.keyspaces#CreateKeyspaceRequest": { @@ -278,7 +278,7 @@ } ], "traits": { - "smithy.api#documentation": "

The CreateTable operation adds a new table to the specified keyspace. Within a keyspace, table names\n must be unique.

\n

\n CreateTable is an asynchronous operation. When the request is received, the status of the table is set to CREATING.\n You can monitor the creation status of the new table by using the GetTable \n operation, which returns the current status of the table. You can start using a table when the status is ACTIVE.

\n

For more information, see Creating tables in the Amazon Keyspaces Developer\n Guide.

" + "smithy.api#documentation": "

The CreateTable operation adds a new table to the specified keyspace. Within a keyspace, table names\n must be unique.

\n

\n CreateTable is an asynchronous operation. When the request is received, the status of the table is set to CREATING.\n You can monitor the creation status of the new table by using the GetTable \n operation, which returns the current status of the table. You can start using a table when the status is ACTIVE.

\n

For more information, see Creating tables in the Amazon Keyspaces Developer\n Guide.

" } }, "com.amazonaws.keyspaces#CreateTableRequest": { @@ -301,7 +301,7 @@ "schemaDefinition": { "target": "com.amazonaws.keyspaces#SchemaDefinition", "traits": { - "smithy.api#documentation": "

The schemaDefinition consists of the\n following parameters.

\n

For each column to be created:

\n \n \n

The primary key of the table consists of the\n following columns:

\n \n

To define a column as static use \n staticColumns\n - \n Static columns store values that are shared by all rows in the same partition:

\n ", + "smithy.api#documentation": "

The schemaDefinition consists of the\n following parameters.

\n

For each column to be created:

\n

• name - The name\n of the column.

\n

• type - An Amazon Keyspaces\n data type. For more information, see Data types in the Amazon Keyspaces Developer\n Guide.

\n

The primary key of the table consists of the\n following columns:

\n

• partitionKeys - The partition key can be a single column, or it can be a\n compound value composed of two or more columns. The partition\n key portion of the primary key is required and determines how\n Amazon Keyspaces stores your data.

\n

• name - The name of each partition key column.

\n

• clusteringKeys - The optional clustering column portion of your primary key\n determines how the data is clustered and sorted within each\n partition.

\n

• name - The name of the clustering column.

\n

• orderBy - Sets the\n ascendant (ASC) or descendant (DESC) order modifier.

\n

To define a column as static use staticColumns - \n Static columns store values that are shared by all rows in the same partition:

\n

• name - The name\n of the column.

\n

• type - An Amazon Keyspaces\n data type.

", "smithy.api#required": {} } }, @@ -314,25 +314,25 @@ "capacitySpecification": { "target": "com.amazonaws.keyspaces#CapacitySpecification", "traits": { - "smithy.api#documentation": "

Specifies the read/write throughput capacity mode for the table. The options are:

\n \n

The default is\n throughput_mode:PAY_PER_REQUEST.

\n

For more information, see Read/write capacity modes in the Amazon Keyspaces Developer\n Guide.

" + "smithy.api#documentation": "

Specifies the read/write throughput capacity mode for the table. The options are:

\n

• throughputMode:PAY_PER_REQUEST and

\n

• throughputMode:PROVISIONED - Provisioned capacity mode requires\n readCapacityUnits and writeCapacityUnits as input.

\n

The default is\n throughput_mode:PAY_PER_REQUEST.

\n

For more information, see Read/write capacity modes in the Amazon Keyspaces Developer\n Guide.

" } }, "encryptionSpecification": { "target": "com.amazonaws.keyspaces#EncryptionSpecification", "traits": { - "smithy.api#documentation": "

Specifies how the encryption key for encryption at rest is managed for the table. You can choose one of the following KMS key (KMS key):

\n \n \n

The default is type:AWS_OWNED_KMS_KEY.

\n

For more information, see Encryption at rest in the Amazon Keyspaces Developer\n Guide.

" + "smithy.api#documentation": "

Specifies how the encryption key for encryption at rest is managed for the table. \n You can choose one of the following KMS key (KMS key):

\n

• type:AWS_OWNED_KMS_KEY - This key is owned by Amazon Keyspaces.

\n

• type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your account and is created, owned, and managed by you. \n This option \n requires the kms_key_identifier of the KMS key in Amazon Resource Name (ARN) format as input.

\n

The default is type:AWS_OWNED_KMS_KEY.

\n

For more information, see Encryption at rest in the Amazon Keyspaces Developer\n Guide.

" } }, "pointInTimeRecovery": { "target": "com.amazonaws.keyspaces#PointInTimeRecovery", "traits": { - "smithy.api#documentation": "

\n Specifies if pointInTimeRecovery is enabled or disabled for the\n table. The options are:

\n \n

If it's not specified, the default is DISABLED.

\n

For more information, see Point-in-time recovery in the Amazon Keyspaces Developer\n Guide.

" + "smithy.api#documentation": "

Specifies if pointInTimeRecovery is enabled or disabled for the\n table. The options are:

\n

• ENABLED\n

\n

• DISABLED\n

\n

If it's not specified, the \n default is DISABLED.

\n

For more information, see Point-in-time recovery in the Amazon Keyspaces Developer\n Guide.

" } }, "ttl": { "target": "com.amazonaws.keyspaces#TimeToLive", "traits": { - "smithy.api#documentation": "

\n Enables Time to Live custom settings for the\n table. The options are:

\n \n

The default is status:disabled. After\n ttl is enabled, you can't disable it\n for the table.

\n

For more information, see Expiring data by using Amazon Keyspaces Time to Live (TTL) in the Amazon Keyspaces Developer\n Guide.

" + "smithy.api#documentation": "

Enables Time to Live custom settings for the\n table. The options are:

\n

• status:enabled\n

\n

• status:disabled\n

\n

The default is status:disabled. After\n ttl is enabled, you can't disable it\n for the table.

\n

For more information, see Expiring data by using Amazon Keyspaces Time to Live (TTL) in the Amazon Keyspaces Developer\n Guide.

" } }, "defaultTimeToLive": { @@ -448,7 +448,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n The DeleteTable operation deletes a table and all of its data. After a DeleteTable request is received, \n the specified table is in the DELETING state until Amazon Keyspaces completes the deletion. If the table \n is in the ACTIVE state, you can delete it. If a table is either in the CREATING or UPDATING states, then \n Amazon Keyspaces returns a ResourceInUseException. If the specified table does not exist, Amazon Keyspaces returns\n a ResourceNotFoundException. If the table is already in the DELETING state, no error is returned.

" + "smithy.api#documentation": "

The DeleteTable operation deletes a table and all of its data. After a DeleteTable request is received, \n the specified table is in the DELETING state until Amazon Keyspaces completes the deletion. If the table \n is in the ACTIVE state, you can delete it. If a table is either in the CREATING or UPDATING states, then \n Amazon Keyspaces returns a ResourceInUseException. If the specified table does not exist, Amazon Keyspaces returns\n a ResourceNotFoundException. If the table is already in the DELETING state, no error is returned.

" } }, "com.amazonaws.keyspaces#DeleteTableRequest": { @@ -480,19 +480,19 @@ "type": { "target": "com.amazonaws.keyspaces#EncryptionType", "traits": { - "smithy.api#documentation": "

\n The encryption option specified for the table. You can choose one of the following KMS keys (KMS keys):

\n \n

The default is type:AWS_OWNED_KMS_KEY.

\n

For more information, see Encryption at rest in the Amazon Keyspaces Developer\n Guide.

", + "smithy.api#documentation": "

The encryption option specified for the table. You can choose one of the following KMS keys (KMS keys):

\n

• type:AWS_OWNED_KMS_KEY - This key is owned by Amazon Keyspaces.

\n

• type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your account and is created, owned, and managed by you. \n This option \n requires the kms_key_identifier of the KMS key in Amazon Resource Name (ARN) format as input.

\n

The default is type:AWS_OWNED_KMS_KEY.

\n

For more information, see Encryption at rest in the Amazon Keyspaces Developer\n Guide.

", "smithy.api#required": {} } }, "kmsKeyIdentifier": { "target": "com.amazonaws.keyspaces#kmsKeyARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the customer managed KMS key, for example kms_key_identifier:ARN.\n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the customer managed KMS key, for example kms_key_identifier:ARN.

" } } }, "traits": { - "smithy.api#documentation": "

\n Amazon Keyspaces encrypts and decrypts the table data at rest transparently and integrates with Key Management Service for storing and managing the encryption key. \n You can choose one of the following KMS keys (KMS keys):

\n \n

For more information about encryption at rest in Amazon Keyspaces, see Encryption at rest in the Amazon Keyspaces Developer\n Guide.

\n

For more information about KMS, see KMS management service concepts in the Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Amazon Keyspaces encrypts and decrypts the table data at rest transparently and integrates with Key Management Service for storing and managing the encryption key. \n You can choose one of the following KMS keys (KMS keys):

\n

• Amazon Web Services owned key - This is the default encryption type. The key is owned by Amazon Keyspaces (no additional charge).

\n

• Customer managed key - This key is stored in your account and is created, owned, and managed by you. You have full control over the customer \n managed key (KMS charges apply).

\n

For more information about encryption at rest in Amazon Keyspaces, see Encryption at rest in the Amazon Keyspaces Developer\n Guide.

\n

For more information about KMS, see KMS management service concepts in the Key Management Service Developer Guide.

" } }, "com.amazonaws.keyspaces#EncryptionType": { @@ -666,7 +666,7 @@ "capacitySpecification": { "target": "com.amazonaws.keyspaces#CapacitySpecificationSummary", "traits": { - "smithy.api#documentation": "

The read/write throughput capacity mode for a table. The options are:

\n " + "smithy.api#documentation": "

The read/write throughput capacity mode for a table. The options are:

\n

• throughputMode:PAY_PER_REQUEST\n

\n

• throughputMode:PROVISIONED\n

" } }, "encryptionSpecification": { @@ -770,7 +770,7 @@ "name": "cassandra" }, "aws.protocols#awsJson1_0": {}, - "smithy.api#documentation": "

Amazon Keyspaces (for Apache Cassandra) is a scalable,\n highly available, and managed Apache Cassandra-compatible database service. Amazon Keyspaces makes it easy to migrate,\n run, and scale Cassandra workloads in the Amazon Web Services Cloud. With just a few clicks on the Amazon Web Services Management Console or a few lines of code, \n you can create keyspaces and tables in Amazon Keyspaces, without deploying any infrastructure or installing software.

\n \n

In addition to supporting Cassandra Query Language (CQL) requests via open-source Cassandra drivers, \n Amazon Keyspaces supports data definition language (DDL) operations to manage keyspaces and tables using the Amazon Web Services SDK and CLI. This API reference describes\n the supported DDL operations in detail.

\n \n

For the list of all supported CQL APIs, see Supported Cassandra APIs, operations, and data types \n in Amazon Keyspaces in the Amazon Keyspaces Developer\n Guide.

\n \n

To learn how Amazon Keyspaces API actions are tracked in CloudTrail, see Amazon Keyspaces information in CloudTrail in the Amazon Keyspaces Developer\n Guide.

\n \n

For more information about Amazon Web Services APIs, for example how to implement retry logic or how to sign Amazon Web Services API requests, see Amazon Web Services APIs in the General Reference.

", + "smithy.api#documentation": "

Amazon Keyspaces (for Apache Cassandra) is a scalable,\n highly available, and managed Apache Cassandra-compatible database service. Amazon Keyspaces makes it easy to migrate,\n run, and scale Cassandra workloads in the Amazon Web Services Cloud. With just a few clicks on the Amazon Web Services Management Console or a few lines of code, \n you can create keyspaces and tables in Amazon Keyspaces, without deploying any infrastructure or installing software.

\n

In addition to supporting Cassandra Query Language (CQL) requests via open-source Cassandra drivers, \n Amazon Keyspaces supports data definition language (DDL) operations to manage keyspaces and tables using the Amazon Web Services SDK and CLI. This API reference describes\n the supported DDL operations in detail.

\n

For the list of all supported CQL APIs, see Supported Cassandra APIs, operations, and data types \n in Amazon Keyspaces in the Amazon Keyspaces Developer\n Guide.

\n

To learn how Amazon Keyspaces API actions are recorded with CloudTrail, see Amazon Keyspaces information in CloudTrail in the Amazon Keyspaces Developer\n Guide.

\n

For more information about Amazon Web Services APIs, for example how to implement retry logic or how to sign Amazon Web Services API requests, see Amazon Web Services APIs in the General Reference.

", "smithy.api#title": "Amazon Keyspaces" }, "version": "2022-02-10", @@ -1069,7 +1069,7 @@ } }, "traits": { - "smithy.api#documentation": "

The partition key portion of the primary key is required \n and determines how Amazon Keyspaces stores the data. \n The partition key can be a single column, or it can be a compound value composed of two or more columns.

" + "smithy.api#documentation": "

The partition key portion of the primary key is required \n and determines how Amazon Keyspaces stores the data. \n The partition key can be a single column, or it can be a compound value composed of two or more columns.

" } }, "com.amazonaws.keyspaces#PartitionKeyList": { @@ -1089,7 +1089,7 @@ "status": { "target": "com.amazonaws.keyspaces#PointInTimeRecoveryStatus", "traits": { - "smithy.api#documentation": "

The options are:

\n ", + "smithy.api#documentation": "

The options are:

\n

• ENABLED\n

\n

• DISABLED\n

", "smithy.api#required": {} } } @@ -1186,7 +1186,7 @@ } ], "traits": { - "smithy.api#documentation": "

Restores the specified table to the specified point in time within the\n earliest_restorable_timestamp and the current time. For more information about restore points, see \n \n Time window for PITR continuous backups in the Amazon Keyspaces Developer Guide. \n

\n

\n Any number of users can execute up to 4 concurrent restores (any type of restore) in a given account.

\n

When you restore using point in time recovery, Amazon Keyspaces restores your source table's schema and data to the state \n based on the selected timestamp (day:hour:minute:second) to a new table. The Time to Live (TTL) settings\n are also restored to the state based on the selected timestamp.

\n

In addition to the table's schema, data, and TTL settings, RestoreTable restores the capacity mode, encryption, and\n point-in-time recovery settings from the source table. \n Unlike the table's schema data and TTL settings, which are restored based on the selected timestamp, \n these settings are always restored based on the table's settings as of the current time or when the table was deleted.

\n

You can also overwrite these settings during restore:

\n \n

For more information, see PITR restore settings in the Amazon Keyspaces Developer\n Guide.

\n

The following settings are not restored, and you must configure them manually for the\n new table.

\n " + "smithy.api#documentation": "

Restores the specified table to the specified point in time within the\n earliest_restorable_timestamp and the current time. For more information about restore points, see \n \n Time window for PITR continuous backups in the Amazon Keyspaces Developer Guide. \n

\n

Any number of users can execute up to 4 concurrent restores (any type of restore) in a given account.

\n

When you restore using point in time recovery,\n Amazon Keyspaces restores your source table's schema and data to the state \n based on the selected timestamp (day:hour:minute:second) to a new table. The Time to Live (TTL) settings\n are also restored to the state based on the selected timestamp.

\n

In addition to the table's schema, data, and TTL settings,\n RestoreTable restores the capacity mode, encryption, and\n point-in-time recovery settings from the source table. \n Unlike the table's schema data and TTL settings, which are restored based on the selected timestamp, \n these settings are always restored based on the table's settings as of the current time or when the table was deleted.

\n

You can also overwrite\n these settings during restore:

\n

• Read/write capacity mode

\n

• Provisioned throughput capacity settings

\n

• Point-in-time (PITR) settings

\n

• Tags

\n

For more \n information, see PITR restore settings in the Amazon Keyspaces Developer\n Guide.

\n

Note that the following settings are not restored, and you must configure them manually for\n the new table:

\n

• Automatic scaling policies (for tables that use provisioned capacity\n mode)

\n

• Identity and Access Management (IAM) policies

\n

• Amazon CloudWatch metrics and alarms

" } }, "com.amazonaws.keyspaces#RestoreTableRequest": { @@ -1229,19 +1229,19 @@ "capacitySpecificationOverride": { "target": "com.amazonaws.keyspaces#CapacitySpecification", "traits": { - "smithy.api#documentation": "

Specifies the read/write throughput capacity mode for the target table. The options are:

\n \n

The default is throughput_mode:PAY_PER_REQUEST.

\n

For more information, see Read/write capacity modes in the Amazon Keyspaces Developer\n Guide.

" + "smithy.api#documentation": "

Specifies the read/write throughput capacity mode for the target table. The options are:

\n

• throughputMode:PAY_PER_REQUEST\n

\n

• throughputMode:PROVISIONED - Provisioned capacity mode requires\n readCapacityUnits and writeCapacityUnits as input.

\n

The default is throughput_mode:PAY_PER_REQUEST.

\n

For more information, see Read/write capacity modes in the Amazon Keyspaces Developer\n Guide.

" } }, "encryptionSpecificationOverride": { "target": "com.amazonaws.keyspaces#EncryptionSpecification", "traits": { - "smithy.api#documentation": "

\n Specifies the encryption settings for the target table. You can choose one of the following KMS key (KMS key):

\n \n \n

The default is type:AWS_OWNED_KMS_KEY.

\n

For more information, see Encryption at rest in the Amazon Keyspaces Developer\n Guide.

" + "smithy.api#documentation": "

Specifies the encryption settings for the target table. You can choose one of the following KMS key (KMS key):

\n

• type:AWS_OWNED_KMS_KEY - This key is owned by Amazon Keyspaces.

\n

• type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your account and is created, owned, and managed by you. \n This option \n requires the kms_key_identifier of the KMS key in Amazon Resource Name (ARN) format as input.

\n

The default is type:AWS_OWNED_KMS_KEY.

\n

For more information, see Encryption at rest in the Amazon Keyspaces Developer\n Guide.

" } }, "pointInTimeRecoveryOverride": { "target": "com.amazonaws.keyspaces#PointInTimeRecovery", "traits": { - "smithy.api#documentation": "

\n Specifies the pointInTimeRecovery settings for the target\n table. The options are:

\n \n

If it's not specified, the default is DISABLED.

\n

For more information, see Point-in-time recovery in the Amazon Keyspaces Developer\n Guide.

" + "smithy.api#documentation": "

Specifies the pointInTimeRecovery settings for the target\n table. The options are:

\n

• ENABLED \n

\n

• DISABLED\n

\n

If it's not specified, the default is DISABLED.

\n

For more information, see Point-in-time recovery in the Amazon Keyspaces Developer\n Guide.

" } }, "tagsOverride": { @@ -1450,7 +1450,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single Amazon Keyspaces resource.

\n

Amazon Web Services-assigned tag names and values are automatically assigned the aws: prefix, which the user cannot assign. \n Amazon Web Services-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the \n prefix user: in the Cost Allocation Report. You cannot backdate the application of a tag.

\n

For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer\n Guide.

" + "smithy.api#documentation": "

Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single Amazon Keyspaces resource.

\n

Amazon Web Services-assigned tag names and values are automatically assigned the aws: prefix, which the user cannot assign. \n Amazon Web Services-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the \n prefix user: in the Cost Allocation Report. You cannot backdate the application of a tag.

\n

For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer\n Guide.

" } }, "com.amazonaws.keyspaces#TagKey": { @@ -1686,31 +1686,31 @@ "addColumns": { "target": "com.amazonaws.keyspaces#ColumnDefinitionList", "traits": { - "smithy.api#documentation": "

For each column to be added to the specified table:

\n " + "smithy.api#documentation": "

For each column to be added to the specified table:

\n

• name - The name\n of the column.

\n

• type - An Amazon Keyspaces\n data type. For more information, see Data types in the Amazon Keyspaces Developer\n Guide.

" } }, "capacitySpecification": { "target": "com.amazonaws.keyspaces#CapacitySpecification", "traits": { - "smithy.api#documentation": "

Modifies the read/write throughput capacity mode for the table. The options are:

\n \n

The default is throughput_mode:PAY_PER_REQUEST.

\n

For more information, see Read/write capacity modes in the Amazon Keyspaces Developer\n Guide.

" + "smithy.api#documentation": "

Modifies the read/write throughput capacity mode for the table. The options are:

\n

• throughputMode:PAY_PER_REQUEST and

\n

• throughputMode:PROVISIONED - Provisioned capacity mode requires\n readCapacityUnits and writeCapacityUnits as input.

\n

The default is throughput_mode:PAY_PER_REQUEST.

\n

For more information, see Read/write capacity modes in the Amazon Keyspaces Developer\n Guide.

" } }, "encryptionSpecification": { "target": "com.amazonaws.keyspaces#EncryptionSpecification", "traits": { - "smithy.api#documentation": "

\n Modifies the encryption settings of the table. You can choose one of the following KMS key (KMS key):

\n \n \n

The default is AWS_OWNED_KMS_KEY.

\n

For more information, see Encryption at rest in the Amazon Keyspaces Developer\n Guide.

" + "smithy.api#documentation": "

Modifies the encryption settings of the table. You can choose one of the following KMS key (KMS key):

\n

• type:AWS_OWNED_KMS_KEY - This key is owned by Amazon Keyspaces.

\n

• type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your account and is created, owned, and managed by you. \n This option \n requires the kms_key_identifier of the KMS key in Amazon Resource Name (ARN) format as input.

\n

The default is AWS_OWNED_KMS_KEY.

\n

For more information, see Encryption at rest in the Amazon Keyspaces Developer\n Guide.

" } }, "pointInTimeRecovery": { "target": "com.amazonaws.keyspaces#PointInTimeRecovery", "traits": { - "smithy.api#documentation": "

\n Modifies the pointInTimeRecovery settings of the table. The options are:

\n \n

If it's not specified, the default is DISABLED.

\n

For more information, see Point-in-time recovery in the Amazon Keyspaces Developer\n Guide.

" + "smithy.api#documentation": "

Modifies the pointInTimeRecovery settings of the table. The options are:

\n

• ENABLED \n

\n

• DISABLED \n

\n

If it's not specified, the default is DISABLED.

\n

For more information, see Point-in-time recovery in the Amazon Keyspaces Developer\n Guide.

" } }, "ttl": { "target": "com.amazonaws.keyspaces#TimeToLive", "traits": { - "smithy.api#documentation": "

Modifies Time to Live custom settings for the table. The options are:

\n \n

The default is status:disabled. After\n ttl is enabled, you can't disable it\n for the table.

\n

For more information, see Expiring data by using Amazon Keyspaces Time to Live (TTL) in the Amazon Keyspaces Developer\n Guide.

" + "smithy.api#documentation": "

Modifies Time to Live custom settings for the table. The options are:

\n

• status:enabled \n

\n

• status:disabled \n

\n

The default is status:disabled. After\n ttl is enabled, you can't disable it\n for the table.

\n

For more information, see Expiring data by using Amazon Keyspaces Time to Live (TTL) in the Amazon Keyspaces Developer\n Guide.

" } }, "defaultTimeToLive": { diff --git a/codegen/sdk-codegen/aws-models/lambda.json b/codegen/sdk-codegen/aws-models/lambda.json index 5d11042684ca4..36ba824e16a79 100644 --- a/codegen/sdk-codegen/aws-models/lambda.json +++ b/codegen/sdk-codegen/aws-models/lambda.json @@ -432,7 +432,7 @@ } ], "traits": { - "smithy.api#documentation": "

Grants an Amazon Web Services service or another account permission to use a function. You can apply the policy at the\n function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier,\n the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function.\n Note: Lambda does not support adding policies to version $LATEST.

\n \n

To grant permission to another account, specify the account ID as the Principal. For Amazon Web Services\n services, the principal is a domain-style identifier defined by the service, like s3.amazonaws.com or\n sns.amazonaws.com. For Amazon Web Services services, you can also specify the ARN of the associated resource as the\n SourceArn. If you grant permission to a service principal without specifying the source, other\n accounts could potentially configure resources in their account to invoke your Lambda function.

\n \n

This action adds a statement to a resource-based permissions policy for the function. For more information\n about function policies, see Lambda Function Policies.

", + "smithy.api#documentation": "

Grants an Amazon Web Services service, account, or organization permission to use a function. You can apply the\n policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier,\n the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function.\n Note: Lambda does not support adding policies to version $LATEST.

\n \n

To grant permission to another account, specify the account ID as the Principal. To grant permission to an\n organization defined in Organizations, specify the organization ID as the PrincipalOrgID.\n For Amazon Web Services services, the principal is a domain-style identifier defined by the service,\n like s3.amazonaws.com or sns.amazonaws.com. For Amazon Web Services services, you can also specify\n the ARN of the associated resource as the SourceArn. If you grant permission to a service principal without\n specifying the source, other accounts could potentially configure resources in their account to invoke your\n Lambda function.

\n \n

This action adds a statement to a resource-based permissions policy for the function. For more information\n about function policies, see Lambda Function Policies.

", "smithy.api#http": { "method": "POST", "uri": "/2015-03-31/functions/{FunctionName}/policy", @@ -502,6 +502,12 @@ "traits": { "smithy.api#documentation": "

Only update the policy if the revision ID matches the ID that's specified. Use this option to avoid modifying a\n policy that has changed since you last read it.

" } + }, + "PrincipalOrgID": { + "target": "com.amazonaws.lambda#PrincipalOrgID", + "traits": { + "smithy.api#documentation": "

The identifier for your organization in Organizations. Use this to grant permissions to all the Amazon Web Services\n accounts under this organization.

" + } } } }, @@ -5837,6 +5843,16 @@ "smithy.api#pattern": "^[^\\s]+$" } }, + "com.amazonaws.lambda#PrincipalOrgID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 34 + }, + "smithy.api#pattern": "^o-[a-z0-9]{10,32}$" + } + }, "com.amazonaws.lambda#ProvisionedConcurrencyConfigList": { "type": "list", "member": { diff --git a/codegen/sdk-codegen/aws-models/location.json b/codegen/sdk-codegen/aws-models/location.json index 8eecef41ea6c0..0bd70e80e8364 100644 --- a/codegen/sdk-codegen/aws-models/location.json +++ b/codegen/sdk-codegen/aws-models/location.json @@ -71,9 +71,8 @@ "hostPrefix": "tracking." }, "smithy.api#http": { - "method": "POST", "uri": "/tracking/v0/trackers/{TrackerName}/consumers", - "code": 200 + "method": "POST" } } }, @@ -132,9 +131,8 @@ "hostPrefix": "tracking." }, "smithy.api#http": { - "method": "POST", "uri": "/tracking/v0/trackers/{TrackerName}/delete-positions", - "code": 200 + "method": "POST" } } }, @@ -232,9 +230,8 @@ "hostPrefix": "geofencing." }, "smithy.api#http": { - "method": "POST", "uri": "/geofencing/v0/collections/{CollectionName}/delete-geofences", - "code": 200 + "method": "POST" } } }, @@ -333,9 +330,8 @@ "hostPrefix": "geofencing." }, "smithy.api#http": { - "method": "POST", "uri": "/geofencing/v0/collections/{CollectionName}/positions", - "code": 200 + "method": "POST" } } }, @@ -441,9 +437,8 @@ "hostPrefix": "tracking." }, "smithy.api#http": { - "method": "POST", "uri": "/tracking/v0/trackers/{TrackerName}/get-positions", - "code": 200 + "method": "POST" }, "smithy.api#readonly": {} } @@ -604,9 +599,8 @@ "hostPrefix": "geofencing." }, "smithy.api#http": { - "method": "POST", "uri": "/geofencing/v0/collections/{CollectionName}/put-geofences", - "code": 200 + "method": "POST" } } }, @@ -775,9 +769,8 @@ "hostPrefix": "tracking." }, "smithy.api#http": { - "method": "POST", "uri": "/tracking/v0/trackers/{TrackerName}/positions", - "code": 200 + "method": "POST" } } }, @@ -899,9 +892,8 @@ "hostPrefix": "routes." }, "smithy.api#http": { - "method": "POST", "uri": "/routes/v0/calculators/{CalculatorName}/calculate/route", - "code": 200 + "method": "POST" }, "smithy.api#readonly": {} } @@ -957,9 +949,8 @@ "hostPrefix": "routes." }, "smithy.api#http": { - "method": "POST", "uri": "/routes/v0/calculators/{CalculatorName}/calculate/route-matrix", - "code": 200 + "method": "POST" }, "smithy.api#readonly": {} } @@ -1282,7 +1273,7 @@ "AvoidTolls": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Avoids ferries when calculating routes.

\n

Default Value: false\n

\n

Valid Values: false | true\n

" + "smithy.api#documentation": "

Avoids tolls when calculating routes.

\n

Default Value: false\n

\n

Valid Values: false | true\n

" } }, "Dimensions": { @@ -1368,9 +1359,8 @@ "hostPrefix": "geofencing." }, "smithy.api#http": { - "method": "POST", "uri": "/geofencing/v0/collections", - "code": 200 + "method": "POST" }, "smithy.api#idempotent": {} } @@ -1389,8 +1379,8 @@ "target": "com.amazonaws.location#PricingPlan", "traits": { "smithy.api#deprecated": { - "since": "2022-02-01", - "message": "Deprecated. If included, the only allowed value is RequestBasedUsage." + "message": "Deprecated. If included, the only allowed value is RequestBasedUsage.", + "since": "2022-02-01" }, "smithy.api#documentation": "

No longer used. If included, the only allowed value is \n RequestBasedUsage.

" } @@ -1399,8 +1389,8 @@ "target": "smithy.api#String", "traits": { "smithy.api#deprecated": { - "since": "2022-02-01", - "message": "Deprecated. No longer allowed." + "message": "Deprecated. No longer allowed.", + "since": "2022-02-01" }, "smithy.api#documentation": "

This parameter is no longer used.

" } @@ -1482,9 +1472,8 @@ "hostPrefix": "maps." }, "smithy.api#http": { - "method": "POST", "uri": "/maps/v0/maps", - "code": 200 + "method": "POST" }, "smithy.api#idempotent": {} } @@ -1510,8 +1499,8 @@ "target": "com.amazonaws.location#PricingPlan", "traits": { "smithy.api#deprecated": { - "since": "2022-02-01", - "message": "Deprecated. If included, the only allowed value is RequestBasedUsage." + "message": "Deprecated. If included, the only allowed value is RequestBasedUsage.", + "since": "2022-02-01" }, "smithy.api#documentation": "

No longer used. If included, the only allowed value is \n RequestBasedUsage.

" } @@ -1587,9 +1576,8 @@ "hostPrefix": "places." }, "smithy.api#http": { - "method": "POST", "uri": "/places/v0/indexes", - "code": 200 + "method": "POST" }, "smithy.api#idempotent": {} } @@ -1615,8 +1603,8 @@ "target": "com.amazonaws.location#PricingPlan", "traits": { "smithy.api#deprecated": { - "since": "2022-02-01", - "message": "Deprecated. If included, the only allowed value is RequestBasedUsage." + "message": "Deprecated. If included, the only allowed value is RequestBasedUsage.", + "since": "2022-02-01" }, "smithy.api#documentation": "

No longer used. If included, the only allowed value is \n RequestBasedUsage.

" } @@ -1698,9 +1686,8 @@ "hostPrefix": "routes." }, "smithy.api#http": { - "method": "POST", "uri": "/routes/v0/calculators", - "code": 200 + "method": "POST" }, "smithy.api#idempotent": {} } @@ -1726,8 +1713,8 @@ "target": "com.amazonaws.location#PricingPlan", "traits": { "smithy.api#deprecated": { - "since": "2022-02-01", - "message": "Deprecated. If included, the only allowed value is RequestBasedUsage." + "message": "Deprecated. If included, the only allowed value is RequestBasedUsage.", + "since": "2022-02-01" }, "smithy.api#documentation": "

No longer used. If included, the only allowed value is \n RequestBasedUsage.

" } @@ -1803,9 +1790,8 @@ "hostPrefix": "tracking." }, "smithy.api#http": { - "method": "POST", "uri": "/tracking/v0/trackers", - "code": 200 + "method": "POST" }, "smithy.api#idempotent": {} } @@ -1824,8 +1810,8 @@ "target": "com.amazonaws.location#PricingPlan", "traits": { "smithy.api#deprecated": { - "since": "2022-02-01", - "message": "Deprecated. If included, the only allowed value is RequestBasedUsage." + "message": "Deprecated. If included, the only allowed value is RequestBasedUsage.", + "since": "2022-02-01" }, "smithy.api#documentation": "

No longer used. If included, the only allowed value is \n RequestBasedUsage.

" } @@ -1840,8 +1826,8 @@ "target": "smithy.api#String", "traits": { "smithy.api#deprecated": { - "since": "2022-02-01", - "message": "Deprecated. No longer allowed." + "message": "Deprecated. No longer allowed.", + "since": "2022-02-01" }, "smithy.api#documentation": "

This parameter is no longer used.

" } @@ -1937,9 +1923,8 @@ "hostPrefix": "geofencing." }, "smithy.api#http": { - "method": "DELETE", "uri": "/geofencing/v0/collections/{CollectionName}", - "code": 200 + "method": "DELETE" }, "smithy.api#idempotent": {} } @@ -1992,8 +1977,8 @@ "hostPrefix": "maps." }, "smithy.api#http": { - "method": "DELETE", "uri": "/maps/v0/maps/{MapName}", + "method": "DELETE", "code": 200 }, "smithy.api#idempotent": {} @@ -2047,8 +2032,8 @@ "hostPrefix": "places." }, "smithy.api#http": { - "method": "DELETE", "uri": "/places/v0/indexes/{IndexName}", + "method": "DELETE", "code": 200 }, "smithy.api#idempotent": {} @@ -2102,8 +2087,8 @@ "hostPrefix": "routes." }, "smithy.api#http": { - "method": "DELETE", "uri": "/routes/v0/calculators/{CalculatorName}", + "method": "DELETE", "code": 200 }, "smithy.api#idempotent": {} @@ -2157,9 +2142,8 @@ "hostPrefix": "tracking." }, "smithy.api#http": { - "method": "DELETE", "uri": "/tracking/v0/trackers/{TrackerName}", - "code": 200 + "method": "DELETE" }, "smithy.api#idempotent": {} } @@ -2212,9 +2196,8 @@ "hostPrefix": "geofencing." }, "smithy.api#http": { - "method": "GET", "uri": "/geofencing/v0/collections/{CollectionName}", - "code": 200 + "method": "GET" }, "smithy.api#readonly": {} } @@ -2260,8 +2243,8 @@ "target": "com.amazonaws.location#PricingPlan", "traits": { "smithy.api#deprecated": { - "since": "2022-02-01", - "message": "Deprecated. Always returns RequestBasedUsage." + "message": "Deprecated. Always returns RequestBasedUsage.", + "since": "2022-02-01" }, "smithy.api#documentation": "

No longer used. Always returns RequestBasedUsage.

" } @@ -2270,8 +2253,8 @@ "target": "smithy.api#String", "traits": { "smithy.api#deprecated": { - "since": "2022-02-01", - "message": "Deprecated. Unused." + "message": "Deprecated. Unused.", + "since": "2022-02-01" }, "smithy.api#documentation": "

No longer used. Always returns an empty string.

" } @@ -2335,9 +2318,8 @@ "hostPrefix": "maps." }, "smithy.api#http": { - "method": "GET", "uri": "/maps/v0/maps/{MapName}", - "code": 200 + "method": "GET" }, "smithy.api#readonly": {} } @@ -2376,8 +2358,8 @@ "target": "com.amazonaws.location#PricingPlan", "traits": { "smithy.api#deprecated": { - "since": "2022-02-01", - "message": "Deprecated. Always returns RequestBasedUsage." + "message": "Deprecated. Always returns RequestBasedUsage.", + "since": "2022-02-01" }, "smithy.api#documentation": "

No longer used. Always returns RequestBasedUsage.

" } @@ -2456,9 +2438,8 @@ "hostPrefix": "places." }, "smithy.api#http": { - "method": "GET", "uri": "/places/v0/indexes/{IndexName}", - "code": 200 + "method": "GET" }, "smithy.api#readonly": {} } @@ -2497,8 +2478,8 @@ "target": "com.amazonaws.location#PricingPlan", "traits": { "smithy.api#deprecated": { - "since": "2022-02-01", - "message": "Deprecated. Always returns RequestBasedUsage." + "message": "Deprecated. Always returns RequestBasedUsage.", + "since": "2022-02-01" }, "smithy.api#documentation": "

No longer used. Always returns RequestBasedUsage.

" } @@ -2577,9 +2558,8 @@ "hostPrefix": "routes." }, "smithy.api#http": { - "method": "GET", "uri": "/routes/v0/calculators/{CalculatorName}", - "code": 200 + "method": "GET" }, "smithy.api#readonly": {} } @@ -2618,8 +2598,8 @@ "target": "com.amazonaws.location#PricingPlan", "traits": { "smithy.api#deprecated": { - "since": "2022-02-01", - "message": "Deprecated. Always returns RequestBasedUsage." + "message": "Deprecated. Always returns RequestBasedUsage.", + "since": "2022-02-01" }, "smithy.api#documentation": "

Always returns RequestBasedUsage.

" } @@ -2691,9 +2671,8 @@ "hostPrefix": "tracking." }, "smithy.api#http": { - "method": "GET", "uri": "/tracking/v0/trackers/{TrackerName}", - "code": 200 + "method": "GET" }, "smithy.api#readonly": {} } @@ -2739,8 +2718,8 @@ "target": "com.amazonaws.location#PricingPlan", "traits": { "smithy.api#deprecated": { - "since": "2022-02-01", - "message": "Deprecated. Always returns RequestBasedUsage." + "message": "Deprecated. Always returns RequestBasedUsage.", + "since": "2022-02-01" }, "smithy.api#documentation": "

Always returns RequestBasedUsage.

" } @@ -2749,8 +2728,8 @@ "target": "smithy.api#String", "traits": { "smithy.api#deprecated": { - "since": "2022-02-01", - "message": "Deprecated. Unused." + "message": "Deprecated. Unused.", + "since": "2022-02-01" }, "smithy.api#documentation": "

No longer used. Always returns an empty string.

" } @@ -2868,7 +2847,7 @@ "Position": { "target": "com.amazonaws.location#Position", "traits": { - "smithy.api#documentation": "

The latest device position defined in WGS 84 format:\n [X or longitude, Y or latitude].

", + "smithy.api#documentation": "

The latest device position defined in WGS 84 format:\n [X or longitude, Y or latitude].

", "smithy.api#required": {} } }, @@ -2939,9 +2918,8 @@ "hostPrefix": "tracking." }, "smithy.api#http": { - "method": "DELETE", "uri": "/tracking/v0/trackers/{TrackerName}/consumers/{ConsumerArn}", - "code": 200 + "method": "DELETE" } } }, @@ -3049,10 +3027,7 @@ ], "traits": { "aws.api#arn": { - "template": "geofence-collection/{CollectionName}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "geofence-collection/{CollectionName}" }, "aws.iam#disableConditionKeyInference": {} } @@ -3102,9 +3077,8 @@ "hostPrefix": "tracking." }, "smithy.api#http": { - "method": "GET", "uri": "/tracking/v0/trackers/{TrackerName}/devices/{DeviceId}/positions/latest", - "code": 200 + "method": "GET" }, "smithy.api#readonly": {} } @@ -3140,9 +3114,8 @@ "hostPrefix": "tracking." }, "smithy.api#http": { - "method": "POST", "uri": "/tracking/v0/trackers/{TrackerName}/devices/{DeviceId}/list-positions", - "code": 200 + "method": "POST" }, "smithy.api#paginated": { "inputToken": "NextToken", @@ -3305,9 +3278,8 @@ "hostPrefix": "geofencing." }, "smithy.api#http": { - "method": "GET", "uri": "/geofencing/v0/collections/{CollectionName}/geofences/{GeofenceId}", - "code": 200 + "method": "GET" }, "smithy.api#readonly": {} } @@ -3404,9 +3376,8 @@ "hostPrefix": "maps." }, "smithy.api#http": { - "method": "GET", "uri": "/maps/v0/maps/{MapName}/glyphs/{FontStack}/{FontUnicodeRange}", - "code": 200 + "method": "GET" }, "smithy.api#readonly": {} } @@ -3425,7 +3396,7 @@ "FontStack": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A comma-separated list of fonts to load glyphs from in order of preference. For\n example, Noto Sans Regular, Arial Unicode.

\n

Valid fonts stacks for Esri styles:

\n \n

Valid font stacks for HERE Technologies styles:

\n ", + "smithy.api#documentation": "

A comma-separated list of fonts to load glyphs from in order of preference. For\n example, Noto Sans Regular, Arial Unicode.

\n

Valid fonts stacks for Esri styles:

\n \n

Valid font stacks for HERE Technologies styles:

\n ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3496,9 +3467,8 @@ "hostPrefix": "maps." }, "smithy.api#http": { - "method": "GET", "uri": "/maps/v0/maps/{MapName}/sprites/{FileName}", - "code": 200 + "method": "GET" }, "smithy.api#readonly": {} } @@ -3575,9 +3545,8 @@ "hostPrefix": "maps." }, "smithy.api#http": { - "method": "GET", "uri": "/maps/v0/maps/{MapName}/style-descriptor", - "code": 200 + "method": "GET" }, "smithy.api#readonly": {} } @@ -3648,9 +3617,8 @@ "hostPrefix": "maps." }, "smithy.api#http": { - "method": "GET", "uri": "/maps/v0/maps/{MapName}/tiles/{Z}/{X}/{Y}", - "code": 200 + "method": "GET" }, "smithy.api#readonly": {} } @@ -3923,15 +3891,14 @@ "hostPrefix": "tracking." }, "smithy.api#http": { - "method": "POST", "uri": "/tracking/v0/trackers/{TrackerName}/list-positions", - "code": 200 + "method": "POST" }, "smithy.api#paginated": { + "pageSize": "MaxResults", "inputToken": "NextToken", "outputToken": "NextToken", - "items": "Entries", - "pageSize": "MaxResults" + "items": "Entries" }, "smithy.api#readonly": {} } @@ -4058,15 +4025,14 @@ "hostPrefix": "geofencing." }, "smithy.api#http": { - "method": "POST", "uri": "/geofencing/v0/list-collections", - "code": 200 + "method": "POST" }, "smithy.api#paginated": { + "pageSize": "MaxResults", "inputToken": "NextToken", "outputToken": "NextToken", - "items": "Entries", - "pageSize": "MaxResults" + "items": "Entries" }, "smithy.api#readonly": {} } @@ -4131,8 +4097,8 @@ "target": "com.amazonaws.location#PricingPlan", "traits": { "smithy.api#deprecated": { - "since": "2022-02-01", - "message": "Deprecated. Always returns RequestBasedUsage." + "message": "Deprecated. Always returns RequestBasedUsage.", + "since": "2022-02-01" }, "smithy.api#documentation": "

No longer used. Always returns RequestBasedUsage.

" } @@ -4141,8 +4107,8 @@ "target": "smithy.api#String", "traits": { "smithy.api#deprecated": { - "since": "2022-02-01", - "message": "Deprecated. Unused." + "message": "Deprecated. Unused.", + "since": "2022-02-01" }, "smithy.api#documentation": "

No longer used. Always returns an empty string.

" } @@ -4252,9 +4218,8 @@ "hostPrefix": "geofencing." }, "smithy.api#http": { - "method": "POST", "uri": "/geofencing/v0/collections/{CollectionName}/list-geofences", - "code": 200 + "method": "POST" }, "smithy.api#paginated": { "inputToken": "NextToken", @@ -4329,15 +4294,14 @@ "hostPrefix": "maps." }, "smithy.api#http": { - "method": "POST", "uri": "/maps/v0/list-maps", - "code": 200 + "method": "POST" }, "smithy.api#paginated": { + "pageSize": "MaxResults", "inputToken": "NextToken", "outputToken": "NextToken", - "items": "Entries", - "pageSize": "MaxResults" + "items": "Entries" }, "smithy.api#readonly": {} } @@ -4409,8 +4373,8 @@ "target": "com.amazonaws.location#PricingPlan", "traits": { "smithy.api#deprecated": { - "since": "2022-02-01", - "message": "Deprecated. Always returns RequestBasedUsage." + "message": "Deprecated. Always returns RequestBasedUsage.", + "since": "2022-02-01" }, "smithy.api#documentation": "

No longer used. Always returns RequestBasedUsage.

" } @@ -4468,15 +4432,14 @@ "hostPrefix": "places." }, "smithy.api#http": { - "method": "POST", "uri": "/places/v0/list-indexes", - "code": 200 + "method": "POST" }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "Entries", - "pageSize": "MaxResults" + "pageSize": "MaxResults", + "items": "Entries" }, "smithy.api#readonly": {} } @@ -4548,8 +4511,8 @@ "target": "com.amazonaws.location#PricingPlan", "traits": { "smithy.api#deprecated": { - "since": "2022-02-01", - "message": "Deprecated. Always returns RequestBasedUsage." + "message": "Deprecated. Always returns RequestBasedUsage.", + "since": "2022-02-01" }, "smithy.api#documentation": "

No longer used. Always returns RequestBasedUsage.

" } @@ -4607,15 +4570,14 @@ "hostPrefix": "routes." }, "smithy.api#http": { - "method": "POST", "uri": "/routes/v0/list-calculators", - "code": 200 + "method": "POST" }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "Entries", - "pageSize": "MaxResults" + "pageSize": "MaxResults", + "items": "Entries" }, "smithy.api#readonly": {} } @@ -4687,8 +4649,8 @@ "target": "com.amazonaws.location#PricingPlan", "traits": { "smithy.api#deprecated": { - "since": "2022-02-01", - "message": "Deprecated. Always returns RequestBasedUsage." + "message": "Deprecated. Always returns RequestBasedUsage.", + "since": "2022-02-01" }, "smithy.api#documentation": "

Always returns RequestBasedUsage.

" } @@ -4750,8 +4712,7 @@ }, "smithy.api#http": { "method": "GET", - "uri": "/tags/{ResourceArn}", - "code": 200 + "uri": "/tags/{ResourceArn}" }, "smithy.api#readonly": {} } @@ -4811,15 +4772,14 @@ "hostPrefix": "tracking." }, "smithy.api#http": { - "method": "POST", "uri": "/tracking/v0/trackers/{TrackerName}/list-consumers", - "code": 200 + "method": "POST" }, "smithy.api#paginated": { + "pageSize": "MaxResults", "inputToken": "NextToken", "outputToken": "NextToken", - "items": "ConsumerArns", - "pageSize": "MaxResults" + "items": "ConsumerArns" }, "smithy.api#readonly": {} } @@ -4899,15 +4859,14 @@ "hostPrefix": "tracking." }, "smithy.api#http": { - "method": "POST", "uri": "/tracking/v0/list-trackers", - "code": 200 + "method": "POST" }, "smithy.api#paginated": { + "pageSize": "MaxResults", "inputToken": "NextToken", "outputToken": "NextToken", - "items": "Entries", - "pageSize": "MaxResults" + "items": "Entries" }, "smithy.api#readonly": {} } @@ -4972,8 +4931,8 @@ "target": "com.amazonaws.location#PricingPlan", "traits": { "smithy.api#deprecated": { - "since": "2022-02-01", - "message": "Deprecated. Always returns RequestBasedUsage." + "message": "Deprecated. Always returns RequestBasedUsage.", + "since": "2022-02-01" }, "smithy.api#documentation": "

Always returns RequestBasedUsage.

" } @@ -4982,8 +4941,8 @@ "target": "smithy.api#String", "traits": { "smithy.api#deprecated": { - "since": "2022-02-01", - "message": "Deprecated. Unused." + "message": "Deprecated. Unused.", + "since": "2022-02-01" }, "smithy.api#documentation": "

No longer used. Always returns an empty string.

" } @@ -5018,10 +4977,7 @@ "traits": { "aws.api#service": { "sdkId": "Location", - "arnNamespace": "geo", - "cloudFormationName": "LocationService", - "cloudTrailEventSource": "geo.amazonaws.com", - "endpointPrefix": "geo" + "arnNamespace": "geo" }, "aws.auth#sigv4": { "name": "geo" @@ -5058,7 +5014,7 @@ "Style": { "target": "com.amazonaws.location#MapStyle", "traits": { - "smithy.api#documentation": "

Specifies the map style selected from an available data provider.

\n

Valid Esri map styles:

\n \n

Valid HERE\n Technologies map styles:

\n ", + "smithy.api#documentation": "

Specifies the map style selected from an available data provider.

\n

Valid Esri map styles:

\n \n

Valid HERE\n Technologies map styles:

\n ", "smithy.api#required": {} } } @@ -5105,10 +5061,7 @@ ], "traits": { "aws.api#arn": { - "template": "map/{MapName}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "map/{MapName}" }, "aws.iam#disableConditionKeyInference": {} } @@ -5252,10 +5205,7 @@ ], "traits": { "aws.api#arn": { - "template": "place-index/{IndexName}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "place-index/{IndexName}" }, "aws.iam#disableConditionKeyInference": {} } @@ -5410,9 +5360,8 @@ "hostPrefix": "geofencing." }, "smithy.api#http": { - "method": "PUT", "uri": "/geofencing/v0/collections/{CollectionName}/geofences/{GeofenceId}", - "code": 200 + "method": "PUT" } } }, @@ -5538,10 +5487,7 @@ ], "traits": { "aws.api#arn": { - "template": "route-calculator/{CalculatorName}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "route-calculator/{CalculatorName}" }, "aws.iam#disableConditionKeyInference": {} } @@ -5581,7 +5527,7 @@ } }, "traits": { - "smithy.api#documentation": "

The result for one SnappedDeparturePosition \n SnappedDestinationPosition pair.

" + "smithy.api#documentation": "

The result for the calculated route of one DeparturePosition \n DestinationPosition pair.

" } }, "com.amazonaws.location#RouteMatrixEntryError": { @@ -5759,9 +5705,8 @@ "hostPrefix": "places." }, "smithy.api#http": { - "method": "POST", "uri": "/places/v0/indexes/{IndexName}/search/position", - "code": 200 + "method": "POST" }, "smithy.api#readonly": {} } @@ -5882,9 +5827,8 @@ "hostPrefix": "places." }, "smithy.api#http": { - "method": "POST", "uri": "/places/v0/indexes/{IndexName}/search/suggestions", - "code": 200 + "method": "POST" }, "smithy.api#readonly": {} } @@ -6051,9 +5995,8 @@ "hostPrefix": "places." }, "smithy.api#http": { - "method": "POST", "uri": "/places/v0/indexes/{IndexName}/search/text", - "code": 200 + "method": "POST" }, "smithy.api#readonly": {} } @@ -6334,8 +6277,7 @@ }, "smithy.api#http": { "method": "POST", - "uri": "/tags/{ResourceArn}", - "code": 200 + "uri": "/tags/{ResourceArn}" } } }, @@ -6480,10 +6422,7 @@ ], "traits": { "aws.api#arn": { - "template": "tracker/{TrackerName}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "tracker/{TrackerName}" }, "aws.cloudformation#cfnResource": { "name": "Tracker" @@ -6603,8 +6542,7 @@ }, "smithy.api#http": { "method": "DELETE", - "uri": "/tags/{ResourceArn}", - "code": 200 + "uri": "/tags/{ResourceArn}" }, "smithy.api#idempotent": {} } @@ -6665,9 +6603,8 @@ "hostPrefix": "geofencing." }, "smithy.api#http": { - "method": "PATCH", "uri": "/geofencing/v0/collections/{CollectionName}", - "code": 200 + "method": "PATCH" }, "smithy.api#idempotent": {} } @@ -6687,8 +6624,8 @@ "target": "com.amazonaws.location#PricingPlan", "traits": { "smithy.api#deprecated": { - "since": "2022-02-01", - "message": "Deprecated. If included, the only allowed value is RequestBasedUsage." + "message": "Deprecated. If included, the only allowed value is RequestBasedUsage.", + "since": "2022-02-01" }, "smithy.api#documentation": "

No longer used. If included, the only allowed value is \n RequestBasedUsage.

" } @@ -6697,8 +6634,8 @@ "target": "smithy.api#String", "traits": { "smithy.api#deprecated": { - "since": "2022-02-01", - "message": "Deprecated. No longer allowed." + "message": "Deprecated. No longer allowed.", + "since": "2022-02-01" }, "smithy.api#documentation": "

This parameter is no longer used.

" } @@ -6768,9 +6705,8 @@ "hostPrefix": "maps." }, "smithy.api#http": { - "method": "PATCH", "uri": "/maps/v0/maps/{MapName}", - "code": 200 + "method": "PATCH" }, "smithy.api#idempotent": {} } @@ -6790,8 +6726,8 @@ "target": "com.amazonaws.location#PricingPlan", "traits": { "smithy.api#deprecated": { - "since": "2022-02-01", - "message": "Deprecated. If included, the only allowed value is RequestBasedUsage." + "message": "Deprecated. If included, the only allowed value is RequestBasedUsage.", + "since": "2022-02-01" }, "smithy.api#documentation": "

No longer used. If included, the only allowed value is \n RequestBasedUsage.

" } @@ -6861,9 +6797,8 @@ "hostPrefix": "places." }, "smithy.api#http": { - "method": "PATCH", "uri": "/places/v0/indexes/{IndexName}", - "code": 200 + "method": "PATCH" }, "smithy.api#idempotent": {} } @@ -6883,8 +6818,8 @@ "target": "com.amazonaws.location#PricingPlan", "traits": { "smithy.api#deprecated": { - "since": "2022-02-01", - "message": "Deprecated. If included, the only allowed value is RequestBasedUsage." + "message": "Deprecated. If included, the only allowed value is RequestBasedUsage.", + "since": "2022-02-01" }, "smithy.api#documentation": "

No longer used. If included, the only allowed value is \n RequestBasedUsage.

" } @@ -6960,9 +6895,8 @@ "hostPrefix": "routes." }, "smithy.api#http": { - "method": "PATCH", "uri": "/routes/v0/calculators/{CalculatorName}", - "code": 200 + "method": "PATCH" }, "smithy.api#idempotent": {} } @@ -6982,8 +6916,8 @@ "target": "com.amazonaws.location#PricingPlan", "traits": { "smithy.api#deprecated": { - "since": "2022-02-01", - "message": "Deprecated. If included, the only allowed value is RequestBasedUsage." + "message": "Deprecated. If included, the only allowed value is RequestBasedUsage.", + "since": "2022-02-01" }, "smithy.api#documentation": "

No longer used. If included, the only allowed value is \n RequestBasedUsage.

" } @@ -7053,9 +6987,8 @@ "hostPrefix": "tracking." }, "smithy.api#http": { - "method": "PATCH", "uri": "/tracking/v0/trackers/{TrackerName}", - "code": 200 + "method": "PATCH" }, "smithy.api#idempotent": {} } @@ -7075,8 +7008,8 @@ "target": "com.amazonaws.location#PricingPlan", "traits": { "smithy.api#deprecated": { - "since": "2022-02-01", - "message": "Deprecated. If included, the only allowed value is RequestBasedUsage." + "message": "Deprecated. If included, the only allowed value is RequestBasedUsage.", + "since": "2022-02-01" }, "smithy.api#documentation": "

No longer used. If included, the only allowed value is \n RequestBasedUsage.

" } @@ -7085,8 +7018,8 @@ "target": "smithy.api#String", "traits": { "smithy.api#deprecated": { - "since": "2022-02-01", - "message": "Deprecated. No longer allowed." + "message": "Deprecated. No longer allowed.", + "since": "2022-02-01" }, "smithy.api#documentation": "

This parameter is no longer used.

" } diff --git a/codegen/sdk-codegen/aws-models/mediaconnect.json b/codegen/sdk-codegen/aws-models/mediaconnect.json index 338bc8a384df7..5a616be3e3ef2 100644 --- a/codegen/sdk-codegen/aws-models/mediaconnect.json +++ b/codegen/sdk-codegen/aws-models/mediaconnect.json @@ -374,6 +374,30 @@ } } }, + "com.amazonaws.mediaconnect#AddMaintenance": { + "type": "structure", + "members": { + "MaintenanceDay": { + "target": "com.amazonaws.mediaconnect#MaintenanceDay", + "traits": { + "smithy.api#documentation": "A day of a week when the maintenance will happen. Use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday.", + "smithy.api#jsonName": "maintenanceDay", + "smithy.api#required": {} + } + }, + "MaintenanceStartHour": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "UTC time when the maintenance will happen. Use 24-hour HH:MM format. Minutes must be 00. Example: 13:00. The default value is 02:00.", + "smithy.api#jsonName": "maintenanceStartHour", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Create maintenance setting for a flow" + } + }, "com.amazonaws.mediaconnect#AddMediaStreamRequest": { "type": "structure", "members": { @@ -738,6 +762,12 @@ "smithy.api#documentation": "The VPC interfaces you want on the flow.", "smithy.api#jsonName": "vpcInterfaces" } + }, + "Maintenance": { + "target": "com.amazonaws.mediaconnect#AddMaintenance", + "traits": { + "smithy.api#jsonName": "maintenance" + } } }, "traits": { @@ -1622,6 +1652,12 @@ "smithy.api#documentation": "The VPC Interfaces for this flow.", "smithy.api#jsonName": "vpcInterfaces" } + }, + "Maintenance": { + "target": "com.amazonaws.mediaconnect#Maintenance", + "traits": { + "smithy.api#jsonName": "maintenance" + } } }, "traits": { @@ -2472,12 +2508,89 @@ "smithy.api#jsonName": "status", "smithy.api#required": {} } + }, + "Maintenance": { + "target": "com.amazonaws.mediaconnect#Maintenance", + "traits": { + "smithy.api#jsonName": "maintenance" + } } }, "traits": { "smithy.api#documentation": "Provides a summary of a flow, including its ARN, Availability Zone, and source type." } }, + "com.amazonaws.mediaconnect#Maintenance": { + "type": "structure", + "members": { + "MaintenanceDay": { + "target": "com.amazonaws.mediaconnect#MaintenanceDay", + "traits": { + "smithy.api#documentation": "A day of a week when the maintenance will happen. Use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday.", + "smithy.api#jsonName": "maintenanceDay" + } + }, + "MaintenanceDeadline": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "The Maintenance has to be performed before this deadline in ISO UTC format. Example: 2021-01-30T08:30:00Z.", + "smithy.api#jsonName": "maintenanceDeadline" + } + }, + "MaintenanceScheduledDate": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "A scheduled date in ISO UTC format when the maintenance will happen. Use YYYY-MM-DD format. Example: 2021-01-30.", + "smithy.api#jsonName": "maintenanceScheduledDate" + } + }, + "MaintenanceStartHour": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "UTC time when the maintenance will happen. Use 24-hour HH:MM format. Minutes must be 00. Example: 13:00. The default value is 02:00.", + "smithy.api#jsonName": "maintenanceStartHour" + } + } + }, + "traits": { + "smithy.api#documentation": "The maintenance setting of a flow" + } + }, + "com.amazonaws.mediaconnect#MaintenanceDay": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Monday", + "name": "Monday" + }, + { + "value": "Tuesday", + "name": "Tuesday" + }, + { + "value": "Wednesday", + "name": "Wednesday" + }, + { + "value": "Thursday", + "name": "Thursday" + }, + { + "value": "Friday", + "name": "Friday" + }, + { + "value": "Saturday", + "name": "Saturday" + }, + { + "value": "Sunday", + "name": "Sunday" + } + ] + } + }, "com.amazonaws.mediaconnect#MaxResults": { "type": "integer", "traits": { @@ -5100,6 +5213,12 @@ "traits": { "smithy.api#jsonName": "sourceFailoverConfig" } + }, + "Maintenance": { + "target": "com.amazonaws.mediaconnect#UpdateMaintenance", + "traits": { + "smithy.api#jsonName": "maintenance" + } } }, "traits": { @@ -5302,6 +5421,35 @@ } } }, + "com.amazonaws.mediaconnect#UpdateMaintenance": { + "type": "structure", + "members": { + "MaintenanceDay": { + "target": "com.amazonaws.mediaconnect#MaintenanceDay", + "traits": { + "smithy.api#documentation": "A day of a week when the maintenance will happen. use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday.", + "smithy.api#jsonName": "maintenanceDay" + } + }, + "MaintenanceScheduledDate": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "A scheduled date in ISO UTC format when the maintenance will happen. Use YYYY-MM-DD format. Example: 2021-01-30.", + "smithy.api#jsonName": "maintenanceScheduledDate" + } + }, + "MaintenanceStartHour": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "UTC time when the maintenance will happen. Use 24-hour HH:MM format. Minutes must be 00. Example: 13:00. The default value is 02:00.", + "smithy.api#jsonName": "maintenanceStartHour" + } + } + }, + "traits": { + "smithy.api#documentation": "Update maintenance setting for a flow" + } + }, "com.amazonaws.mediaconnect#VpcInterface": { "type": "structure", "members": { diff --git a/codegen/sdk-codegen/aws-models/outposts.json b/codegen/sdk-codegen/aws-models/outposts.json index 56a63bb8e164f..6493e41bea6a0 100644 --- a/codegen/sdk-codegen/aws-models/outposts.json +++ b/codegen/sdk-codegen/aws-models/outposts.json @@ -398,6 +398,12 @@ "smithy.api#pattern": "^\\S[\\S ]*$" } }, + "com.amazonaws.outposts#CityList": { + "type": "list", + "member": { + "target": "com.amazonaws.outposts#City" + } + }, "com.amazonaws.outposts#ConflictException": { "type": "structure", "members": { @@ -453,6 +459,12 @@ "smithy.api#pattern": "^[A-Z]{2}$" } }, + "com.amazonaws.outposts#CountryCodeList": { + "type": "list", + "member": { + "target": "com.amazonaws.outposts#CountryCode" + } + }, "com.amazonaws.outposts#CreateOrder": { "type": "operation", "input": { @@ -1700,7 +1712,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the sites for your Amazon Web Services account.

", + "smithy.api#documentation": "

Create a list of the Outpost sites for your Amazon Web Services account. Add operating address filters to your request to\n return a more specific list of results. Use filters to match site city, country code, or state/region of the \n operating address.

\n \n

If you specify multiple filters, the filters are joined with an AND, and the request returns only \n results that match all of the specified filters.

", "smithy.api#http": { "method": "GET", "uri": "/sites", @@ -1727,6 +1739,27 @@ "traits": { "smithy.api#httpQuery": "MaxResults" } + }, + "OperatingAddressCountryCodeFilter": { + "target": "com.amazonaws.outposts#CountryCodeList", + "traits": { + "smithy.api#documentation": "

A filter for the country code of the Outpost site.

\n

Filter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.

", + "smithy.api#httpQuery": "OperatingAddressCountryCodeFilter" + } + }, + "OperatingAddressStateOrRegionFilter": { + "target": "com.amazonaws.outposts#StateOrRegionList", + "traits": { + "smithy.api#documentation": "

A filter for the state/region of the Outpost site.

\n

Filter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.

", + "smithy.api#httpQuery": "OperatingAddressStateOrRegionFilter" + } + }, + "OperatingAddressCityFilter": { + "target": "com.amazonaws.outposts#CityList", + "traits": { + "smithy.api#documentation": "

\n A filter for the city of the Outpost site. \n

\n

Filter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.

", + "smithy.api#httpQuery": "OperatingAddressCityFilter" + } } } }, @@ -2649,6 +2682,12 @@ "smithy.api#pattern": "^\\S[\\S ]*$" } }, + "com.amazonaws.outposts#StateOrRegionList": { + "type": "list", + "member": { + "target": "com.amazonaws.outposts#StateOrRegion" + } + }, "com.amazonaws.outposts#String": { "type": "string", "traits": { diff --git a/codegen/sdk-codegen/aws-models/quicksight.json b/codegen/sdk-codegen/aws-models/quicksight.json index 1e56f145f8b60..af3a0c527b480 100644 --- a/codegen/sdk-codegen/aws-models/quicksight.json +++ b/codegen/sdk-codegen/aws-models/quicksight.json @@ -2240,7 +2240,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an Amazon QuickSight group.

\n\t\t

The permissions resource is\n\t\t\t\t\tarn:aws:quicksight:us-east-1::group/default/\n .

\n\t\t

The response is a group object.

", + "smithy.api#documentation": "

Creates an Amazon QuickSight group.

\n\t\t

The permissions resource is\n\t\t\t\t\tarn:aws:quicksight:::group/default/\n .

\n\t\t

The response is a group object.

", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups", @@ -2318,7 +2318,7 @@ "Namespace": { "target": "com.amazonaws.quicksight#Namespace", "traits": { - "smithy.api#documentation": "

The namespace. Currently, you should set this to default.

", + "smithy.api#documentation": "

The namespace that you want the user to be a part of.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2376,7 +2376,7 @@ "Namespace": { "target": "com.amazonaws.quicksight#Namespace", "traits": { - "smithy.api#documentation": "

The namespace. Currently, you should set this to default.

", + "smithy.api#documentation": "

The namespace that you want the group to be a part of.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5401,7 +5401,7 @@ "Namespace": { "target": "com.amazonaws.quicksight#Namespace", "traits": { - "smithy.api#documentation": "

The namespace. Currently, you should set this to default.

", + "smithy.api#documentation": "

The namespace of the group that you want to remove a user from.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5448,7 +5448,7 @@ "Namespace": { "target": "com.amazonaws.quicksight#Namespace", "traits": { - "smithy.api#documentation": "

The namespace. Currently, you should set this to default.

", + "smithy.api#documentation": "

The namespace of the group that you want to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7424,6 +7424,104 @@ } } }, + "com.amazonaws.quicksight#DescribeGroupMembership": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeGroupMembershipRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeGroupMembershipResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Use the DescribeGroupMembership operation to determine if a user is a\n\t\t\tmember of the specified group. If the user exists and is a member of the specified\n\t\t\tgroup, an associated GroupMember object is returned.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members/{MemberName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeGroupMembershipRequest": { + "type": "structure", + "members": { + "MemberName": { + "target": "com.amazonaws.quicksight#GroupMemberName", + "traits": { + "smithy.api#documentation": "

The user name of the user that you want to search for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "GroupName": { + "target": "com.amazonaws.quicksight#GroupName", + "traits": { + "smithy.api#documentation": "

The name of the group that you want to search.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the \n Amazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace that includes the group you are searching within.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.quicksight#DescribeGroupMembershipResponse": { + "type": "structure", + "members": { + "GroupMember": { + "target": "com.amazonaws.quicksight#GroupMember" + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + } + }, "com.amazonaws.quicksight#DescribeGroupRequest": { "type": "structure", "members": { @@ -7446,7 +7544,7 @@ "Namespace": { "target": "com.amazonaws.quicksight#Namespace", "traits": { - "smithy.api#documentation": "

The namespace. Currently, you should set this to default.

", + "smithy.api#documentation": "

The namespace of the group that you want described.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9606,6 +9704,28 @@ } } }, + "com.amazonaws.quicksight#GroupFilterAttribute": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "GROUP_NAME", + "name": "GROUP_NAME" + } + ] + } + }, + "com.amazonaws.quicksight#GroupFilterOperator": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "StartsWith", + "name": "StartsWith" + } + ] + } + }, "com.amazonaws.quicksight#GroupList": { "type": "list", "member": { @@ -9657,6 +9777,47 @@ "smithy.api#pattern": "^[\\u0020-\\u00FF]+$" } }, + "com.amazonaws.quicksight#GroupSearchFilter": { + "type": "structure", + "members": { + "Operator": { + "target": "com.amazonaws.quicksight#GroupFilterOperator", + "traits": { + "smithy.api#documentation": "

The comparison operator that you want to use as a filter, for example \"Operator\":\n \"StartsWith\". Currently, the only supported operator is\n StartsWith.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#GroupFilterAttribute", + "traits": { + "smithy.api#documentation": "

The name of the value that you want to use as a filter, for example \"Name\":\n \"GROUP_NAME\". Currently, the only supported name is\n GROUP_NAME.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The value of the named item, in this case GROUP_NAME, that you want to use as a filter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A GroupSearchFilter object that you want to apply to your search.

" + } + }, + "com.amazonaws.quicksight#GroupSearchFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#GroupSearchFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, "com.amazonaws.quicksight#GutterStyle": { "type": "structure", "members": { @@ -11303,7 +11464,7 @@ "Namespace": { "target": "com.amazonaws.quicksight#Namespace", "traits": { - "smithy.api#documentation": "

The namespace. Currently, you should set this to default.

", + "smithy.api#documentation": "

The namespace of the group that you want a list of users from.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11412,7 +11573,7 @@ "Namespace": { "target": "com.amazonaws.quicksight#Namespace", "traits": { - "smithy.api#documentation": "

The namespace. Currently, you should set this to default.

", + "smithy.api#documentation": "

The namespace that you want a list of groups from.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -13735,6 +13896,9 @@ { "target": "com.amazonaws.quicksight#DescribeGroup" }, + { + "target": "com.amazonaws.quicksight#DescribeGroupMembership" + }, { "target": "com.amazonaws.quicksight#DescribeIAMPolicyAssignment" }, @@ -13861,6 +14025,9 @@ { "target": "com.amazonaws.quicksight#SearchFolders" }, + { + "target": "com.amazonaws.quicksight#SearchGroups" + }, { "target": "com.amazonaws.quicksight#TagResource" }, @@ -14110,7 +14277,7 @@ "CustomPermissionsName": { "target": "com.amazonaws.quicksight#RoleName", "traits": { - "smithy.api#documentation": "

(Enterprise edition only) The name of the custom permissions profile that you want to\n assign to this user. Customized permissions allows you to control a user's access by\n restricting access the following operations:

\n \n

To add custom permissions to an existing user, use \n UpdateUser\n instead.

\n

A set of custom permissions includes any combination of these restrictions. Currently,\n you need to create the profile names for custom permission sets by using the Amazon QuickSight\n console. Then, you use the RegisterUser API operation to assign the named set of\n permissions to a QuickSight user.

\n

Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they\n override the permissions typically granted by assigning Amazon QuickSight users to one of the\n default security cohorts in Amazon QuickSight (admin, author, reader).

\n

This feature is available only to Amazon QuickSight Enterprise edition subscriptions.

" + "smithy.api#documentation": "

(Enterprise edition only) The name of the custom permissions profile that you want to\n assign to this user. Customized permissions allows you to control a user's access by\n restricting access the following operations:

\n \n

To add custom permissions to an existing user, use \n UpdateUser\n instead.

\n

A set of custom permissions includes any combination of these restrictions. Currently,\n you need to create the profile names for custom permission sets by using the Amazon QuickSight\n console. Then, you use the RegisterUser API operation to assign the named set of\n permissions to a Amazon QuickSight user.

\n

Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they\n override the permissions typically granted by assigning Amazon QuickSight users to one of the\n default security cohorts in Amazon QuickSight (admin, author, reader).

\n

This feature is available only to Amazon QuickSight Enterprise edition subscriptions.

" } }, "ExternalLoginFederationProviderType": { @@ -15145,6 +15312,122 @@ } } }, + "com.amazonaws.quicksight#SearchGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#SearchGroupsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#SearchGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Use the SearchGroups operation to search groups in a specified Amazon QuickSight namespace using the supplied filters.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups-search", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#SearchGroupsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n Amazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of results to return from this request.

", + "smithy.api#httpQuery": "max-results" + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace that you want to search.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.quicksight#GroupSearchFilterList", + "traits": { + "smithy.api#documentation": "

The structure for the search filters that you want to apply to your search.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.quicksight#SearchGroupsResponse": { + "type": "structure", + "members": { + "GroupList": { + "target": "com.amazonaws.quicksight#GroupList", + "traits": { + "smithy.api#documentation": "

A list of groups in a specified namespace that match the filters you set in your SearchGroups request.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + } + }, "com.amazonaws.quicksight#ServiceNowParameters": { "type": "structure", "members": { @@ -18335,7 +18618,7 @@ "Namespace": { "target": "com.amazonaws.quicksight#Namespace", "traits": { - "smithy.api#documentation": "

The namespace. Currently, you should set this to default.

", + "smithy.api#documentation": "

The namespace of the group that you want to update.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -19357,7 +19640,7 @@ "CustomPermissionsName": { "target": "com.amazonaws.quicksight#RoleName", "traits": { - "smithy.api#documentation": "

(Enterprise edition only) The name of the custom permissions profile that you want to\n assign to this user. Customized permissions allows you to control a user's access by\n restricting access the following operations:

\n \n

A set of custom permissions includes any combination of these restrictions. Currently,\n you need to create the profile names for custom permission sets by using the Amazon QuickSight\n console. Then, you use the RegisterUser API operation to assign the named set of\n permissions to a QuickSight user.

\n

Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they\n override the permissions typically granted by assigning Amazon QuickSight users to one of the\n default security cohorts in Amazon QuickSight (admin, author, reader).

\n

This feature is available only to Amazon QuickSight Enterprise edition subscriptions.

" + "smithy.api#documentation": "

(Enterprise edition only) The name of the custom permissions profile that you want to\n assign to this user. Customized permissions allows you to control a user's access by\n restricting access the following operations:

\n \n

A set of custom permissions includes any combination of these restrictions. Currently,\n you need to create the profile names for custom permission sets by using the Amazon QuickSight\n console. Then, you use the RegisterUser API operation to assign the named set of\n permissions to a Amazon QuickSight user.

\n

Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they\n override the permissions typically granted by assigning Amazon QuickSight users to one of the\n default security cohorts in Amazon QuickSight (admin, author, reader).

\n

This feature is available only to Amazon QuickSight Enterprise edition subscriptions.

" } }, "UnapplyCustomPermissions": { diff --git a/codegen/sdk-codegen/aws-models/ram.json b/codegen/sdk-codegen/aws-models/ram.json index f9597d06ed64b..68ba859a80f49 100644 --- a/codegen/sdk-codegen/aws-models/ram.json +++ b/codegen/sdk-codegen/aws-models/ram.json @@ -1256,7 +1256,7 @@ "resourceOwner": { "target": "com.amazonaws.ram#ResourceOwner", "traits": { - "smithy.api#documentation": "

Specifies that you want to retrieve details of only those resource shares that match the\n following:

\n ", + "smithy.api#documentation": "

Specifies that you want to retrieve details of only those resource shares that match the\n following:

\n ", "smithy.api#required": {} } }, @@ -1766,7 +1766,7 @@ "resourceOwner": { "target": "com.amazonaws.ram#ResourceOwner", "traits": { - "smithy.api#documentation": "

Specifies that you want to list information for only resource shares that match the\n following:

\n ", + "smithy.api#documentation": "

Specifies that you want to list information for only resource shares that match the\n following:

\n ", "smithy.api#required": {} } }, @@ -1785,7 +1785,7 @@ "resourceType": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

Specifies that you want to list information for only principals associated with resource shares\n that include the specified resource type.

\n

For a list of valid values, query the ListResourceTypes operation.

" + "smithy.api#documentation": "

Specifies that you want to list information for only principals associated with resource shares\n that include the specified resource type.

\n

For a list of valid values, query the ListResourceTypes\n operation.

" } }, "resourceShareArns": { @@ -2019,7 +2019,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the resources that you added to a resource shares or the resources that are shared with\n you.

", + "smithy.api#documentation": "

Lists the resources that you added to a resource share or the resources that are shared with\n you.

", "smithy.api#http": { "method": "POST", "uri": "/listresources", @@ -2038,7 +2038,7 @@ "resourceOwner": { "target": "com.amazonaws.ram#ResourceOwner", "traits": { - "smithy.api#documentation": "

Specifies that you want to list only the resource shares that match the following:

\n ", + "smithy.api#documentation": "

Specifies that you want to list only the resource shares that match the following:

\n ", "smithy.api#required": {} } }, @@ -2285,7 +2285,7 @@ } ], "traits": { - "smithy.api#documentation": "

When you attach a resource-based permission policy to a resource, it automatically\n creates a resource share. However, resource shares created this way are visible only to the resource share\n owner, and the resource share can't be modified in RAM.

\n

You can use this operation to promote the resource share to a full RAM resource share. When you promote\n a resource share, you can then manage the resource share in RAM and it becomes visible to all of the\n principals you shared it with.

", + "smithy.api#documentation": "

When you attach a resource-based permission policy to a resource, it automatically\n creates a resource share. However, resource shares created this way are visible only to the resource share owner, and\n the resource share can't be modified in RAM.

\n

You can use this operation to promote the resource share to a full RAM resource share. When you promote\n a resource share, you can then manage the resource share in RAM and it becomes visible to all of the\n principals you shared it with.

", "smithy.api#http": { "method": "POST", "uri": "/promoteresourcesharecreatedfrompolicy", diff --git a/codegen/sdk-codegen/aws-models/rds.json b/codegen/sdk-codegen/aws-models/rds.json index 74cfba8e73772..0f5b2facbbd34 100644 --- a/codegen/sdk-codegen/aws-models/rds.json +++ b/codegen/sdk-codegen/aws-models/rds.json @@ -66,7 +66,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes a quota for an Amazon Web Services account.

\n

The following are account quotas:

\n \n

For more information, see Quotas for Amazon RDS in the\n Amazon RDS User Guide and Quotas for Amazon Aurora in the\n Amazon Aurora User Guide.

" + "smithy.api#documentation": "

Describes a quota for an Amazon Web Services account.

\n

The following are account quotas:

\n \n

For more information, see Quotas for Amazon RDS in the\n Amazon RDS User Guide and Quotas for Amazon Aurora in the\n Amazon Aurora User Guide.

" } }, "com.amazonaws.rds#AccountQuotaList": { @@ -206,14 +206,14 @@ "RoleArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to associate with the DB instance, for\n example arn:aws:iam::123456789012:role/AccessRole.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to associate with the DB instance, for\n example arn:aws:iam::123456789012:role/AccessRole.

", "smithy.api#required": {} } }, "FeatureName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the feature for the DB instance that the IAM role is to be associated with. \n For information about supported feature names, see DBEngineVersion.\n

", + "smithy.api#documentation": "

The name of the feature for the DB instance that the IAM role is to be associated with. \n For information about supported feature names, see DBEngineVersion.

", "smithy.api#required": {} } } @@ -252,7 +252,7 @@ "SourceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The identifier of the event source to be added.

\n

Constraints:

\n ", + "smithy.api#documentation": "

The identifier of the event source to be added.

\n

Constraints:

\n ", "smithy.api#required": {} } } @@ -292,7 +292,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS.

\n

For an overview on tagging Amazon RDS resources, \n see Tagging Amazon RDS Resources.

" + "smithy.api#documentation": "

Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS.

\n

For an overview on tagging Amazon RDS resources, \n see Tagging Amazon RDS Resources.

" } }, "com.amazonaws.rds#AddTagsToResourceMessage": { @@ -331,7 +331,7 @@ "name": "rds" }, "aws.protocols#awsQuery": {}, - "smithy.api#documentation": "Amazon Relational Database Service\n

\n

Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and \n scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational \n database and manages common database administration tasks, freeing up developers to focus on what makes their applications \n and businesses unique.

\n

Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, \n Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools \n you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS \n automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS \n is flexible: you can scale your DB instance's compute resources and storage capacity to meet your \n application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for \n the resources you use.

\n

This interface reference for Amazon RDS contains documentation for a programming or command line interface \n you can use to manage Amazon RDS. Amazon RDS is asynchronous, which means that some interfaces might \n require techniques such as polling or callback functions to determine when a command has been applied. In this \n reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, \n or during the maintenance window. The reference structure is as follows, and we list following some related topics \n from the user guide.

\n \n

\n Amazon RDS API Reference\n

\n \n \n \n

\n Amazon RDS User Guide\n

\n \n ", + "smithy.api#documentation": "Amazon Relational Database Service\n

\n \n

Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and \n scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational \n database and manages common database administration tasks, freeing up developers to focus on what makes their applications \n and businesses unique.

\n

Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, \n Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools \n you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS \n automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS \n is flexible: you can scale your DB instance's compute resources and storage capacity to meet your \n application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for \n the resources you use.

\n

This interface reference for Amazon RDS contains documentation for a programming or command line interface \n you can use to manage Amazon RDS. Amazon RDS is asynchronous, which means that some interfaces might \n require techniques such as polling or callback functions to determine when a command has been applied. In this \n reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, \n or during the maintenance window. The reference structure is as follows, and we list following some related topics \n from the user guide.

\n

\n Amazon RDS API Reference\n

\n \n

\n Amazon RDS User Guide\n

\n ", "smithy.api#title": "Amazon Relational Database Service", "smithy.api#xmlNamespace": { "uri": "http://rds.amazonaws.com/doc/2014-10-31/" @@ -815,14 +815,14 @@ "ApplyAction": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The pending maintenance action to apply to this resource.

\n

Valid values: system-update, db-upgrade, \n hardware-maintenance, ca-certificate-rotation\n

", + "smithy.api#documentation": "

The pending maintenance action to apply to this resource.

\n

Valid values: system-update, db-upgrade, \n hardware-maintenance, ca-certificate-rotation\n

", "smithy.api#required": {} } }, "OptInType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in \n request of type immediate can't be undone.

\n

Valid values:

\n ", + "smithy.api#documentation": "

A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in \n request of type immediate can't be undone.

\n

Valid values:

\n ", "smithy.api#required": {} } } @@ -933,7 +933,7 @@ } ], "traits": { - "smithy.api#documentation": "

Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security \n groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC \n instances. Second, IP ranges are available if the application accessing your database is running on the internet. \n Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId \n and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).

\n \n

You can't authorize ingress from an EC2 security group in one Amazon Web Services Region to an Amazon RDS DB instance in \n another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.

\n \n

For an overview of CIDR ranges, go to the \n Wikipedia Tutorial.\n

" + "smithy.api#documentation": "

Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security \n groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC \n instances. Second, IP ranges are available if the application accessing your database is running on the internet. \n Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId \n and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).

\n \n

You can't authorize ingress from an EC2 security group in one Amazon Web Services Region to an Amazon RDS DB instance in \n another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.

\n \n

For an overview of CIDR ranges, go to the \n Wikipedia Tutorial.

" } }, "com.amazonaws.rds#AuthorizeDBSecurityGroupIngressMessage": { @@ -955,19 +955,19 @@ "EC2SecurityGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n Name of the EC2 security group to authorize.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName \n or EC2SecurityGroupId must be provided.\n

" + "smithy.api#documentation": "

Name of the EC2 security group to authorize.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName \n or EC2SecurityGroupId must be provided.

" } }, "EC2SecurityGroupId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n Id of the EC2 security group to authorize.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.\n

" + "smithy.api#documentation": "

Id of the EC2 security group to authorize.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" } }, "EC2SecurityGroupOwnerId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n Amazon Web Services account number of the owner of the EC2 security group\n specified in the EC2SecurityGroupName parameter.\n The Amazon Web Services access key ID isn't an acceptable value.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.\n

" + "smithy.api#documentation": "

Amazon Web Services account number of the owner of the EC2 security group\n specified in the EC2SecurityGroupName parameter.\n The Amazon Web Services access key ID isn't an acceptable value.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" } } }, @@ -1009,7 +1009,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains Availability Zone information.

\n

This data type is used as an element in the OrderableDBInstanceOption\n data type.

" + "smithy.api#documentation": "

Contains Availability Zone information.

\n

This data type is used as an element in the OrderableDBInstanceOption\n data type.

" } }, "com.amazonaws.rds#AvailabilityZoneList": { @@ -1092,7 +1092,7 @@ } ], "traits": { - "smithy.api#documentation": "

Backtracks a DB cluster to a specific time, without creating a new DB cluster.

\n

For more information on backtracking, see \n \n Backtracking an Aurora DB Cluster in the \n Amazon Aurora User Guide.\n

\n \n

This action only applies to Aurora MySQL DB clusters.

\n " + "smithy.api#documentation": "

Backtracks a DB cluster to a specific time, without creating a new DB cluster.

\n

For more information on backtracking, see \n \n Backtracking an Aurora DB Cluster in the \n Amazon Aurora User Guide.

\n \n

This action only applies to Aurora MySQL DB clusters.

\n " } }, "com.amazonaws.rds#BacktrackDBClusterMessage": { @@ -1101,7 +1101,7 @@ "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The DB cluster identifier of the DB cluster to be backtracked. This parameter is\n stored as a lowercase string.

\n

Constraints:

\n \n

Example: my-cluster1\n

", + "smithy.api#documentation": "

The DB cluster identifier of the DB cluster to be backtracked. This parameter is\n stored as a lowercase string.

\n

Constraints:

\n \n

Example: my-cluster1\n

", "smithy.api#required": {} } }, @@ -1184,7 +1184,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels an export task in progress that is exporting a snapshot to Amazon S3. \n Any data that has already been written to the S3 bucket isn't removed.\n

" + "smithy.api#documentation": "

Cancels an export task in progress that is exporting a snapshot to Amazon S3. \n Any data that has already been written to the S3 bucket isn't removed.

" } }, "com.amazonaws.rds#CancelExportTaskMessage": { @@ -1276,7 +1276,7 @@ "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous\n DescribeCertificates request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeCertificates request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .

" } } }, @@ -1296,7 +1296,7 @@ "code": "CertificateNotFound", "httpResponseCode": 404 }, - "smithy.api#documentation": "

\n CertificateIdentifier doesn't refer to an\n existing certificate.\n

", + "smithy.api#documentation": "

\n CertificateIdentifier doesn't refer to an\n existing certificate.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -1318,7 +1318,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n This data type is used as a response element in the action DescribeDBEngineVersions. \n

" + "smithy.api#documentation": "

This data type is used as a response element in the action DescribeDBEngineVersions.

" } }, "com.amazonaws.rds#CloudwatchLogsExportConfiguration": { @@ -1382,31 +1382,31 @@ "MaxConnectionsPercent": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the\n max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.

\n

Default: 100

\n

Constraints: between 1 and 100

" + "smithy.api#documentation": "

The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the\n max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.

\n

Default: 100

\n

Constraints: between 1 and 100

" } }, "MaxIdleConnectionsPercent": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

\n Controls how actively the proxy closes idle database connections in the connection pool.\n\t\tThe value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.\n With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.\n

\n

Default: 50

\n

Constraints: between 0 and MaxConnectionsPercent\n

" + "smithy.api#documentation": "

Controls how actively the proxy closes idle database connections in the connection pool.\n The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.\n With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.

\n

Default: 50

\n

Constraints: between 0 and MaxConnectionsPercent\n

" } }, "ConnectionBorrowTimeout": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the\n proxy has opened its maximum number of connections and all connections are busy with client sessions.

\n

Default: 120

\n

Constraints: between 1 and 3600, or 0 representing unlimited

" + "smithy.api#documentation": "

The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the\n proxy has opened its maximum number of connections and all connections are busy with client sessions.

\n

Default: 120

\n

Constraints: between 1 and 3600, or 0 representing unlimited

" } }, "SessionPinningFilters": { "target": "com.amazonaws.rds#StringList", "traits": { - "smithy.api#documentation": "

Each item in the list represents a class of SQL operations that normally cause all later statements\n in a session using a proxy to be pinned to the same underlying database connection. Including an item\n in the list exempts that class of SQL operations from the pinning behavior.

\n

Default: no session pinning filters

" + "smithy.api#documentation": "

Each item in the list represents a class of SQL operations that normally cause all later statements\n in a session using a proxy to be pinned to the same underlying database connection. Including an item\n in the list exempts that class of SQL operations from the pinning behavior.

\n

Default: no session pinning filters

" } }, "InitQuery": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n One or more SQL statements for the proxy to run when opening each new database connection.\n Typically used with SET statements to make sure that each connection has identical\n settings such as time zone and character set. For multiple statements, use semicolons as the separator.\n You can also include multiple variables in a single SET statement, such as\n SET x=1, y=2.\n

\n

Default: no initialization query

" + "smithy.api#documentation": "

One or more SQL statements for the proxy to run when opening each new database connection.\n Typically used with SET statements to make sure that each connection has identical\n settings such as time zone and character set. For multiple statements, use semicolons as the separator.\n You can also include multiple variables in a single SET statement, such as\n SET x=1, y=2.

\n

Default: no initialization query

" } } }, @@ -1426,7 +1426,7 @@ "MaxIdleConnectionsPercent": { "target": "com.amazonaws.rds#Integer", "traits": { - "smithy.api#documentation": "

\n Controls how actively the proxy closes idle database connections in the connection pool.\n\t\tThe value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.\n With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database. \n

" + "smithy.api#documentation": "

Controls how actively the proxy closes idle database connections in the connection pool.\n The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.\n With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.

" } }, "ConnectionBorrowTimeout": { @@ -1444,7 +1444,7 @@ "InitQuery": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n One or more SQL statements for the proxy to run when opening each new database connection.\n Typically used with SET statements to make sure that each connection has identical\n settings such as time zone and character set. This setting is empty by default.\n For multiple statements, use semicolons as the separator.\n You can also include multiple variables in a single SET statement, such as\n SET x=1, y=2.\n

" + "smithy.api#documentation": "

One or more SQL statements for the proxy to run when opening each new database connection.\n Typically used with SET statements to make sure that each connection has identical\n settings such as time zone and character set. This setting is empty by default.\n For multiple statements, use semicolons as the separator.\n You can also include multiple variables in a single SET statement, such as\n SET x=1, y=2.

" } } }, @@ -1481,14 +1481,14 @@ "SourceDBClusterParameterGroupIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group.\n For information about \n creating an ARN, \n see \n Constructing an ARN for Amazon RDS in the Amazon Aurora User Guide.\n

\n

Constraints:

\n ", + "smithy.api#documentation": "

The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group.\n For information about \n creating an ARN, \n see \n Constructing an ARN for Amazon RDS in the Amazon Aurora User Guide.

\n

Constraints:

\n ", "smithy.api#required": {} } }, "TargetDBClusterParameterGroupIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The identifier for the copied DB cluster parameter group.

\n

Constraints:

\n \n

Example: my-cluster-param-group1\n

", + "smithy.api#documentation": "

The identifier for the copied DB cluster parameter group.

\n

Constraints:

\n \n

Example: my-cluster-param-group1\n

", "smithy.api#required": {} } }, @@ -1541,7 +1541,7 @@ } ], "traits": { - "smithy.api#documentation": "

Copies a snapshot of a DB cluster.

\n

To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier\n must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.

\n\n

You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case, the Amazon Web Services Region where you call the CopyDBClusterSnapshot action \n is the destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another Amazon Web Services Region, \n you must provide the following values:

\n \n \n

To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified\n by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in \"copying\" status.

\n

For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see \n \n Copying a Snapshot in the Amazon Aurora User Guide.\n

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

Copies a snapshot of a DB cluster.

\n

To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier\n must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.

\n

You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case, the Amazon Web Services Region where you call the CopyDBClusterSnapshot action \n is the destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another Amazon Web Services Region, \n you must provide the following values:

\n \n

To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified\n by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in \"copying\" status.

\n

For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see \n \n Copying a Snapshot in the Amazon Aurora User Guide.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

" } }, "com.amazonaws.rds#CopyDBClusterSnapshotMessage": { @@ -1550,27 +1550,27 @@ "SourceDBClusterSnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The identifier of the DB cluster snapshot to copy. This parameter isn't case-sensitive.

\n

You can't copy an encrypted, shared DB cluster snapshot from one Amazon Web Services Region to another.

\n

Constraints:

\n \n

Example: my-cluster-snapshot1\n

", + "smithy.api#documentation": "

The identifier of the DB cluster snapshot to copy. This parameter isn't case-sensitive.

\n

You can't copy an encrypted, shared DB cluster snapshot from one Amazon Web Services Region to another.

\n

Constraints:

\n \n

Example: my-cluster-snapshot1\n

", "smithy.api#required": {} } }, "TargetDBClusterSnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter isn't case-sensitive.

\n

Constraints:

\n \n

Example: my-cluster-snapshot2\n

", + "smithy.api#documentation": "

The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter isn't case-sensitive.

\n

Constraints:

\n \n

Example: my-cluster-snapshot2\n

", "smithy.api#required": {} } }, "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot. \n The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS key.

\n \n

If you copy an encrypted DB cluster snapshot from your Amazon Web Services account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS key. \n If you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot. \n

\n \n

If you copy an encrypted DB cluster snapshot that is shared from another Amazon Web Services account, then you must specify a value for KmsKeyId.

\n \n

To copy an encrypted DB cluster snapshot to another Amazon Web Services Region, you must set KmsKeyId to the Amazon Web Services KMS key identifier \n you want to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services \n Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region \n in another Amazon Web Services Region.

\n \n

If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, \n an error is returned.

" + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot. \n The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS key.

\n

If you copy an encrypted DB cluster snapshot from your Amazon Web Services account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS key. \n If you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot.

\n

If you copy an encrypted DB cluster snapshot that is shared from another Amazon Web Services account, then you must specify a value for KmsKeyId.

\n

To copy an encrypted DB cluster snapshot to another Amazon Web Services Region, you must set KmsKeyId to the Amazon Web Services KMS key identifier \n you want to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services \n Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region \n in another Amazon Web Services Region.

\n

If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, \n an error is returned.

" } }, "PreSignedUrl": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the Amazon Web Services Region that contains the \n source DB cluster snapshot to copy. The PreSignedUrl parameter must be used when copying an encrypted DB cluster snapshot from another Amazon Web Services Region. \n Don't specify PreSignedUrl when you are copying an encrypted DB cluster snapshot in the same Amazon Web Services Region.

\n

The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be\n executed in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to be copied. \n The pre-signed URL request must contain the following parameter values:

\n \n \n \n

To learn how to generate a Signature Version 4 signed request, see \n\n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.

\n \n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) \n instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid \n request for the operation that can be executed in the source Amazon Web Services Region.

\n " + "smithy.api#documentation": "

The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the Amazon Web Services Region that contains the \n source DB cluster snapshot to copy. The PreSignedUrl parameter must be used when copying an encrypted DB cluster snapshot from another Amazon Web Services Region. \n Don't specify PreSignedUrl when you are copying an encrypted DB cluster snapshot in the same Amazon Web Services Region.

\n

The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be\n executed in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to be copied. \n The pre-signed URL request must contain the following parameter values:

\n \n

To learn how to generate a Signature Version 4 signed request, see \n\n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) \n instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid \n request for the operation that can be executed in the source Amazon Web Services Region.

\n " } }, "CopyTags": { @@ -1624,14 +1624,14 @@ "SourceDBParameterGroupIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n The identifier or ARN for the source DB parameter group.\n For information about \n creating an ARN, \n see \n Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.\n

\n

Constraints:

\n ", + "smithy.api#documentation": "

The identifier or ARN for the source DB parameter group.\n For information about \n creating an ARN, \n see \n Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

\n

Constraints:

\n ", "smithy.api#required": {} } }, "TargetDBParameterGroupIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The identifier for the copied DB parameter group.

\n

Constraints:

\n \n

Example: my-db-parameter-group\n

", + "smithy.api#documentation": "

The identifier for the copied DB parameter group.

\n

Constraints:

\n \n

Example: my-db-parameter-group\n

", "smithy.api#required": {} } }, @@ -1687,7 +1687,7 @@ } ], "traits": { - "smithy.api#documentation": "

Copies the specified DB snapshot. The source DB snapshot must be in the available state.

\n \n

You can copy a snapshot from one Amazon Web Services Region to another. In that case, the Amazon Web Services Region\n where you call the CopyDBSnapshot action is the destination Amazon Web Services Region for the\n DB snapshot copy.

\n \n

This command doesn't apply to RDS Custom.

\n \n

For more information about copying snapshots, see \n Copying a DB Snapshot in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

Copies the specified DB snapshot. The source DB snapshot must be in the available state.

\n

You can copy a snapshot from one Amazon Web Services Region to another. In that case, the Amazon Web Services Region\n where you call the CopyDBSnapshot action is the destination Amazon Web Services Region for the\n DB snapshot copy.

\n

This command doesn't apply to RDS Custom.

\n

For more information about copying snapshots, see \n Copying a DB Snapshot in the Amazon RDS User Guide.

" } }, "com.amazonaws.rds#CopyDBSnapshotMessage": { @@ -1696,21 +1696,21 @@ "SourceDBSnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The identifier for the source DB snapshot.

\n \n

If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB\n snapshot identifier. For example, you might specify\n rds:mysql-instance1-snapshot-20130805.

\n \n

If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB\n snapshot ARN. For example, you might specify\n arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.

\n\n

If you are copying from a shared manual DB snapshot, \n this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.\n

\n \n

If you are copying an encrypted snapshot\n this parameter must be in the ARN format for the source Amazon Web Services Region, \n and must match the SourceDBSnapshotIdentifier in the PreSignedUrl parameter.\n

\n \n

Constraints:

\n \n\n

Example: rds:mydb-2012-04-02-00-01\n

\n\n

Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805\n

", + "smithy.api#documentation": "

The identifier for the source DB snapshot.

\n

If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB\n snapshot identifier. For example, you might specify\n rds:mysql-instance1-snapshot-20130805.

\n

If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB\n snapshot ARN. For example, you might specify\n arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.

\n

If you are copying from a shared manual DB snapshot, \n this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.

\n

If you are copying an encrypted snapshot\n this parameter must be in the ARN format for the source Amazon Web Services Region, \n and must match the SourceDBSnapshotIdentifier in the PreSignedUrl parameter.

\n

Constraints:

\n \n

Example: rds:mydb-2012-04-02-00-01\n

\n

Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805\n

", "smithy.api#required": {} } }, "TargetDBSnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The identifier for the copy of the snapshot.\n

\n \n

Constraints:

\n \n \n\n

Example: my-db-snapshot\n

", + "smithy.api#documentation": "

The identifier for the copy of the snapshot.

\n

Constraints:

\n \n

Example: my-db-snapshot\n

", "smithy.api#required": {} } }, "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB snapshot. \n The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. \n

\n \n

If you copy an encrypted DB snapshot from your Amazon Web Services account, \n you can specify a value for this parameter to encrypt the copy with a new KMS key. \n If you don't specify a value for this parameter, \n then the copy of the DB snapshot is encrypted with the same Amazon Web Services KMS key as the source DB snapshot. \n

\n\n

If you copy an encrypted DB snapshot that is shared from another Amazon Web Services account, \n then you must specify a value for this parameter.\n

\n \n

If you specify this parameter when you copy an unencrypted snapshot, \n the copy is encrypted.\n

\n \n

If you copy an encrypted snapshot to a different Amazon Web Services Region, then you must specify\n an Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region\n that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another\n Amazon Web Services Region.\n

" + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB snapshot. \n The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you copy an encrypted DB snapshot from your Amazon Web Services account, \n you can specify a value for this parameter to encrypt the copy with a new KMS key. \n If you don't specify a value for this parameter, \n then the copy of the DB snapshot is encrypted with the same Amazon Web Services KMS key as the source DB snapshot.

\n

If you copy an encrypted DB snapshot that is shared from another Amazon Web Services account, \n then you must specify a value for this parameter.

\n

If you specify this parameter when you copy an unencrypted snapshot, \n the copy is encrypted.

\n

If you copy an encrypted snapshot to a different Amazon Web Services Region, then you must specify\n an Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region\n that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another\n Amazon Web Services Region.

" } }, "Tags": { @@ -1725,13 +1725,13 @@ "PreSignedUrl": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The URL that contains a Signature Version 4 signed request for the\n CopyDBSnapshot API action in the source Amazon Web Services Region that contains the\n source DB snapshot to copy.

\n \n

You must specify this parameter when you copy an encrypted DB snapshot from another\n Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are \n copying an encrypted DB snapshot in the same Amazon Web Services Region.

\n \n

The presigned URL must be a valid request for the CopyDBSnapshot API action \n that can be executed in the source Amazon Web Services Region that contains the encrypted DB snapshot to be copied. \n The presigned URL request must contain the following parameter values:\n

\n \n \n\n\t

To learn how to generate a Signature Version 4 signed request, see \n\t\tAuthenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n\t\tSignature Version 4 Signing Process.\n\t

\n \n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) \n instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid \n request for the operation that can be executed in the source Amazon Web Services Region.

\n " + "smithy.api#documentation": "

The URL that contains a Signature Version 4 signed request for the\n CopyDBSnapshot API action in the source Amazon Web Services Region that contains the\n source DB snapshot to copy.

\n

You must specify this parameter when you copy an encrypted DB snapshot from another\n Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are \n copying an encrypted DB snapshot in the same Amazon Web Services Region.

\n

The presigned URL must be a valid request for the CopyDBSnapshot API action \n that can be executed in the source Amazon Web Services Region that contains the encrypted DB snapshot to be copied. \n The presigned URL request must contain the following parameter values:

\n \n

To learn how to generate a Signature Version 4 signed request, see \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) \n instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid \n request for the operation that can be executed in the source Amazon Web Services Region.

\n " } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of an option group to associate with the copy of the snapshot.

\n \n

Specify this option if you are copying a snapshot from one Amazon Web Services Region to another,\n and your DB instance uses a nondefault option group. \n If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, \n you must specify this option when copying across Amazon Web Services Regions. \n For more information, see \n Option group considerations in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

The name of an option group to associate with the copy of the snapshot.

\n

Specify this option if you are copying a snapshot from one Amazon Web Services Region to another,\n and your DB instance uses a nondefault option group. \n If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, \n you must specify this option when copying across Amazon Web Services Regions. \n For more information, see \n Option group considerations in the Amazon RDS User Guide.

" } }, "TargetCustomAvailabilityZone": { @@ -1782,14 +1782,14 @@ "SourceOptionGroupIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The identifier for the source option group.\n

\n

Constraints:

\n ", + "smithy.api#documentation": "

The identifier for the source option group.

\n

Constraints:

\n ", "smithy.api#required": {} } }, "TargetOptionGroupIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The identifier for the copied option group.

\n

Constraints:

\n \n

Example: my-option-group\n

", + "smithy.api#documentation": "

The identifier for the copied option group.

\n

Constraints:

\n \n

Example: my-option-group\n

", "smithy.api#required": {} } }, @@ -1900,7 +1900,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a custom DB engine version (CEV). A CEV is a binary volume snapshot of a database engine and specific\n AMI. The supported engines are the following:

\n \n

Amazon RDS, which is a fully managed service, supplies the Amazon Machine Image (AMI) and database software.\n The Amazon RDS database software is preinstalled, so you need only select a DB engine and version, and create\n your database. With Amazon RDS Custom for Oracle, you upload your database installation files in Amazon S3.

\n

When you create a custom engine version, you specify the files in a JSON document called a CEV manifest. \n This document describes installation .zip files stored in Amazon S3. RDS Custom creates your CEV from \n the installation files that you provided. This service model is called Bring Your Own Media (BYOM).

\n

Creation takes approximately two hours. If creation fails, RDS Custom issues RDS-EVENT-0196 with \n the message Creation failed for custom engine version, and includes details about the failure. \n For example, the event prints missing files.

\n

After you create the CEV, it is available for use. You can create multiple CEVs, and create multiple \n RDS Custom instances from any CEV. You can also change the status of a CEV to make it available or\n inactive.

\n \n

The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with \n Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the \n CreateCustomDbEngineVersion event aren't logged. However, you might see calls from the \n API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for \n the CreateCustomDbEngineVersion event.

\n \n

For more information, see \n Creating a CEV in the Amazon RDS User Guide.

" + "smithy.api#documentation": "

Creates a custom DB engine version (CEV). A CEV is a binary volume snapshot of a database engine and specific\n AMI. The supported engines are the following:

\n \n

Amazon RDS, which is a fully managed service, supplies the Amazon Machine Image (AMI) and database software.\n The Amazon RDS database software is preinstalled, so you need only select a DB engine and version, and create\n your database. With Amazon RDS Custom for Oracle, you upload your database installation files in Amazon S3.

\n

When you create a custom engine version, you specify the files in a JSON document called a CEV manifest. \n This document describes installation .zip files stored in Amazon S3. RDS Custom creates your CEV from \n the installation files that you provided. This service model is called Bring Your Own Media (BYOM).

\n

Creation takes approximately two hours. If creation fails, RDS Custom issues RDS-EVENT-0196 with \n the message Creation failed for custom engine version, and includes details about the failure. \n For example, the event prints missing files.

\n

After you create the CEV, it is available for use. You can create multiple CEVs, and create multiple \n RDS Custom instances from any CEV. You can also change the status of a CEV to make it available or\n inactive.

\n \n

The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with \n Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the \n CreateCustomDbEngineVersion event aren't logged. However, you might see calls from the \n API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for \n the CreateCustomDbEngineVersion event.

\n \n

For more information, see \n Creating a CEV in the Amazon RDS User Guide.

" } }, "com.amazonaws.rds#CreateCustomDBEngineVersionMessage": { @@ -1949,7 +1949,7 @@ "Manifest": { "target": "com.amazonaws.rds#CustomDBEngineVersionManifest", "traits": { - "smithy.api#documentation": "

The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. \n Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which \n they are listed.

\n

The following JSON fields are valid:

\n
\n
MediaImportTemplateVersion
\n
\n

Version of the CEV manifest. The date is in the format YYYY-MM-DD.

\n
\n
databaseInstallationFileNames
\n
\n

Ordered list of installation files for the CEV.

\n
\n
opatchFileNames
\n
\n

Ordered list of OPatch installers used for the Oracle DB engine.

\n
\n
psuRuPatchFileNames
\n
\n

The PSU and RU patches for this CEV.

\n
\n
OtherPatchFileNames
\n
\n

The patches that are not in the list of PSU and RU patches. \n Amazon RDS applies these patches after applying the PSU and RU patches.

\n
\n
\n

For more information, see \n Creating the CEV manifest in the Amazon RDS User Guide.

", + "smithy.api#documentation": "

The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. \n Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which \n they are listed.

\n

The following JSON fields are valid:

\n
\n
MediaImportTemplateVersion
\n
\n

Version of the CEV manifest. The date is in the format YYYY-MM-DD.

\n
\n
databaseInstallationFileNames
\n
\n

Ordered list of installation files for the CEV.

\n
\n
opatchFileNames
\n
\n

Ordered list of OPatch installers used for the Oracle DB engine.

\n
\n
psuRuPatchFileNames
\n
\n

The PSU and RU patches for this CEV.

\n
\n
OtherPatchFileNames
\n
\n

The patches that are not in the list of PSU and RU patches. \n Amazon RDS applies these patches after applying the PSU and RU patches.

\n
\n
\n

For more information, see \n Creating the CEV manifest in the Amazon RDS User Guide.

", "smithy.api#required": {} } }, @@ -2023,7 +2023,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.

\n

You can use the ReplicationSourceIdentifier parameter to create an Amazon\n Aurora DB cluster as a read replica of another DB cluster or Amazon RDS MySQL or\n PostgreSQL DB instance. For cross-Region replication where the DB cluster identified by\n ReplicationSourceIdentifier is encrypted, also specify the\n PreSignedUrl parameter.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.

\n

You can use the ReplicationSourceIdentifier parameter to create an Amazon\n Aurora DB cluster as a read replica of another DB cluster or Amazon RDS MySQL or\n PostgreSQL DB instance. For cross-Region replication where the DB cluster identified by\n ReplicationSourceIdentifier is encrypted, also specify the\n PreSignedUrl parameter.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

" } }, "com.amazonaws.rds#CreateDBClusterEndpoint": { @@ -2108,105 +2108,105 @@ "AvailabilityZones": { "target": "com.amazonaws.rds#AvailabilityZones", "traits": { - "smithy.api#documentation": "

A list of Availability Zones (AZs) where DB instances in the DB cluster can be created.\n

\n

For information on Amazon Web Services Regions and Availability Zones, see \n Choosing the Regions and \n Availability Zones in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

A list of Availability Zones (AZs) where DB instances in the DB cluster can be created.

\n

For information on Amazon Web Services Regions and Availability Zones, see \n Choosing the Regions and \n Availability Zones in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" } }, "BackupRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of days for which automated backups are retained.

\n

Default: 1

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The number of days for which automated backups are retained.

\n

Default: 1

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "CharacterSetName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

A value that indicates that the DB cluster should be associated with the specified CharacterSet.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

A value that indicates that the DB cluster should be associated with the specified CharacterSet.

\n

Valid for: Aurora DB clusters only

" } }, "DatabaseName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name for your database of up to 64 alphanumeric characters. If you do not\n provide a name, Amazon RDS doesn't create a database in the DB cluster you are\n creating.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The name for your database of up to 64 alphanumeric characters. If you do not\n provide a name, Amazon RDS doesn't create a database in the DB cluster you are\n creating.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The DB cluster identifier. This parameter is stored as a lowercase string.

\n

Constraints:

\n \n

Example: my-cluster1\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", + "smithy.api#documentation": "

The DB cluster identifier. This parameter is stored as a lowercase string.

\n

Constraints:

\n \n

Example: my-cluster1\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", "smithy.api#required": {} } }, "DBClusterParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n The name of the DB cluster parameter group to associate\n with this DB cluster. If you do not specify a value, then \n the default DB cluster parameter group for the specified DB engine and version is used.\n

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The name of the DB cluster parameter group to associate\n with this DB cluster. If you do not specify a value, then \n the default DB cluster parameter group for the specified DB engine and version is used.

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "VpcSecurityGroupIds": { "target": "com.amazonaws.rds#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "

A list of EC2 VPC security groups to associate with this DB cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

A list of EC2 VPC security groups to associate with this DB cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

A DB subnet group to associate with this DB cluster.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

\n

Example: mydbsubnetgroup\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

A DB subnet group to associate with this DB cluster.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

\n

Example: mydbsubnetgroup\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the database engine to be used for this DB cluster.

\n

Valid Values:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", + "smithy.api#documentation": "

The name of the database engine to be used for this DB cluster.

\n

Valid Values:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", "smithy.api#required": {} } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The version number of the database engine to use.

\n

To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for Aurora PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for MySQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n

\n

\n Aurora MySQL\n

\n

For information, see MySQL on Amazon RDS Versions in the \n Amazon Aurora User Guide.\n

\n

\n Aurora PostgreSQL\n

\n

For information, see Amazon Aurora PostgreSQL releases and engine versions in the \n Amazon Aurora User Guide.\n

\n

\n MySQL\n

\n

For information, see MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.\n

\n

\n PostgreSQL\n

\n

For information, see Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The version number of the database engine to use.

\n

To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for Aurora PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for MySQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n

\n

\n Aurora MySQL\n

\n

For information, see MySQL on Amazon RDS Versions in the \n Amazon Aurora User Guide.

\n

\n Aurora PostgreSQL\n

\n

For information, see Amazon Aurora PostgreSQL releases and engine versions in the \n Amazon Aurora User Guide.

\n

\n MySQL\n

\n

For information, see MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.

\n

\n PostgreSQL\n

\n

For information, see Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "Port": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The port number on which the instances in the DB cluster accept connections.

\n

\n RDS for MySQL and Aurora MySQL\n

\n

\n Default: 3306\n

\n

\n Valid values: 1150-65535\n

\n

\n RDS for PostgreSQL and Aurora PostgreSQL\n

\n

\n Default: 5432\n

\n

\n Valid values: 1150-65535\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The port number on which the instances in the DB cluster accept connections.

\n

\n RDS for MySQL and Aurora MySQL\n

\n

Default: 3306\n

\n

Valid values: 1150-65535\n

\n

\n RDS for PostgreSQL and Aurora PostgreSQL\n

\n

Default: 5432\n

\n

Valid values: 1150-65535\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "MasterUsername": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the master user for the DB cluster.

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The name of the master user for the DB cluster.

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "MasterUserPassword": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

\n

Constraints: Must contain from 8 to 41 characters.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

\n

Constraints: Must contain from 8 to 41 characters.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

A value that indicates that the DB cluster should be associated with the specified option group.

\n

DB clusters are associated with a default option group that can't be modified.

" + "smithy.api#documentation": "

A value that indicates that the DB cluster should be associated with the specified option group.

\n

DB clusters are associated with a default option group that can't be modified.

" } }, "PreferredBackupWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled\n using the BackupRetentionPeriod parameter.\n

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.\n

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled\n using the BackupRetentionPeriod parameter.

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "PreferredMaintenanceWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.\n

\n

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

\n

Constraints: Minimum 30-minute window.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

\n

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

\n

Constraints: Minimum 30-minute window.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "ReplicationSourceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB\n cluster is created as a read replica.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB\n cluster is created as a read replica.

\n

Valid for: Aurora DB clusters only

" } }, "Tags": { @@ -2218,43 +2218,43 @@ "StorageEncrypted": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB cluster is encrypted.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

A value that indicates whether the DB cluster is encrypted.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB cluster.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

When a KMS key isn't specified in KmsKeyId:

\n \n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

\n

If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, you\n must set KmsKeyId to a KMS key identifier that is valid in the destination Amazon Web Services\n Region. This KMS key is used to encrypt the read replica in that Amazon Web Services Region.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB cluster.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

When a KMS key isn't specified in KmsKeyId:

\n \n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

\n

If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, you\n must set KmsKeyId to a KMS key identifier that is valid in the destination Amazon Web Services\n Region. This KMS key is used to encrypt the read replica in that Amazon Web Services Region.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "PreSignedUrl": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

A URL that contains a Signature Version 4 signed request for \n the CreateDBCluster action to be called in the source Amazon Web Services Region where the DB cluster is replicated from. \n Specify PreSignedUrl only when you are performing cross-Region replication from an encrypted DB cluster.

\n

The pre-signed URL must be a valid request for the CreateDBCluster API action \n that can be executed in the source Amazon Web Services Region that contains the encrypted DB cluster to be copied.

\n

The pre-signed URL request must contain the following parameter values:

\n \n

To learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) \n instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid \n request for the operation that can be executed in the source Amazon Web Services Region.

\n \n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

A URL that contains a Signature Version 4 signed request for \n the CreateDBCluster action to be called in the source Amazon Web Services Region where the DB cluster is replicated from. \n Specify PreSignedUrl only when you are performing cross-Region replication from an encrypted DB cluster.

\n

The pre-signed URL must be a valid request for the CreateDBCluster API action \n that can be executed in the source Amazon Web Services Region that contains the encrypted DB cluster to be copied.

\n

The pre-signed URL request must contain the following parameter values:

\n \n

To learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) \n instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid \n request for the operation that can be executed in the source Amazon Web Services Region.

\n \n

Valid for: Aurora DB clusters only

" } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.\n

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide..

\n

Valid for: Aurora DB clusters only

" } }, "BacktrackWindow": { "target": "com.amazonaws.rds#LongOptional", "traits": { - "smithy.api#documentation": "

The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

\n\n

Default: 0

\n

Constraints:

\n \n

Valid for: Aurora MySQL DB clusters only

" + "smithy.api#documentation": "

The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

\n

Default: 0

\n

Constraints:

\n \n

Valid for: Aurora MySQL DB clusters only

" } }, "EnableCloudwatchLogsExports": { "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "

The list of log types that need to be enabled for exporting to CloudWatch Logs. The values\n in the list depend on the DB engine being used.

\n

\n RDS for MySQL\n

\n

Possible values are error, general, and slowquery.

\n

\n RDS for PostgreSQL\n

\n

Possible values are postgresql and upgrade.

\n

\n Aurora MySQL\n

\n

Possible values are audit, error, general, and slowquery.

\n

\n Aurora PostgreSQL\n

\n

Possible value is postgresql.

\n

For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database\n Service User Guide.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The list of log types that need to be enabled for exporting to CloudWatch Logs. The values\n in the list depend on the DB engine being used.

\n

\n RDS for MySQL\n

\n

Possible values are error, general, and slowquery.

\n

\n RDS for PostgreSQL\n

\n

Possible values are postgresql and upgrade.

\n

\n Aurora MySQL\n

\n

Possible values are audit, error, general, and slowquery.

\n

\n Aurora PostgreSQL\n

\n

Possible value is postgresql.

\n

For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "EngineMode": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The DB engine mode of the DB cluster, either provisioned, serverless, \n parallelquery, global, or multimaster.

\n

The parallelquery engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, \n and version 2.09 and higher 2.x versions.

\n

The global engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, \n and global engine mode isn't required for any 2.x versions.

\n

The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a.

\n

For Aurora PostgreSQL, the global engine mode isn't required, and both the parallelquery \n and the multimaster engine modes currently aren't supported.

\n

Limitations and requirements apply to some DB engine modes. For more information, see the \n following sections in the Amazon Aurora User Guide:

\n \n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

The DB engine mode of the DB cluster, either provisioned, serverless, \n parallelquery, global, or multimaster.

\n

The parallelquery engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, \n and version 2.09 and higher 2.x versions.

\n

The global engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, \n and global engine mode isn't required for any 2.x versions.

\n

The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a.

\n

For Aurora PostgreSQL, the global engine mode isn't required, and both the parallelquery \n and the multimaster engine modes currently aren't supported.

\n

Limitations and requirements apply to some DB engine modes. For more information, see the \n following sections in the Amazon Aurora User Guide:

\n \n

Valid for: Aurora DB clusters only

" } }, "ScalingConfiguration": { @@ -2272,13 +2272,13 @@ "GlobalClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n The global cluster ID of an Aurora cluster that becomes the primary cluster\n in the new global database cluster.\n

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

The global cluster ID of an Aurora cluster that becomes the primary cluster\n in the new global database cluster.

\n

Valid for: Aurora DB clusters only

" } }, "EnableHttpEndpoint": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint \n is disabled.

\n

When enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless DB cluster. You can also query your database\n from inside the RDS console with the query editor.

\n

For more information, see Using the Data API for Aurora Serverless in the \n Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint \n is disabled.

\n

When enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database\n from inside the RDS console with the query editor.

\n

For more information, see Using the Data API for Aurora Serverless v1 in the \n Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" } }, "CopyTagsToSnapshot": { @@ -2290,7 +2290,7 @@ "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Active Directory directory ID to create the DB cluster in.

\n

\n For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.

\n

For more information, see Kerberos authentication\n in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

The Active Directory directory ID to create the DB cluster in.

\n

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.

\n

For more information, see Kerberos authentication\n in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" } }, "DomainIAMRoleName": { @@ -2302,13 +2302,13 @@ "EnableGlobalWriteForwarding": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an\n Aurora global database (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that\n are secondary clusters in an Aurora global database.

\n

You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter\n enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to\n this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the\n primary is demoted by the FailoverGlobalCluster API operation, but it does nothing until then.\n

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an\n Aurora global database (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that\n are secondary clusters in an Aurora global database.

\n

You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter\n enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to\n this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the\n primary is demoted by the FailoverGlobalCluster API operation, but it does nothing until then.

\n

Valid for: Aurora DB clusters only

" } }, "DBClusterInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

\n

For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide.\n

\n

This setting is required to create a Multi-AZ DB cluster.

\n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

\n

For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

Valid for: Multi-AZ DB clusters only

" } }, "AllocatedStorage": { @@ -2320,19 +2320,19 @@ "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the DB cluster.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

\n Valid values: io1\n

\n

\n When specified, a value for the Iops parameter is required.\n

\n

\n Default: io1\n

\n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

Specifies the storage type to be associated with the DB cluster.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

Valid values: io1\n

\n

When specified, a value for the Iops parameter is required.

\n

Default: io1\n

\n

Valid for: Multi-AZ DB clusters only

" } }, "Iops": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated \n for each DB instance in the Multi-AZ DB cluster.

\n

For information about valid Iops values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide.\n

\n

This setting is required to create a Multi-AZ DB cluster.

\n

Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.

\n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated \n for each DB instance in the Multi-AZ DB cluster.

\n

For information about valid Iops values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.

\n

Valid for: Multi-AZ DB clusters only

" } }, "PubliclyAccessible": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB cluster is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

\n

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

\n

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

A value that indicates whether the DB cluster is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

\n

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

\n

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

Valid for: Multi-AZ DB clusters only

" } }, "AutoMinorVersionUpgrade": { @@ -2344,7 +2344,7 @@ "MonitoringInterval": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off \n collecting Enhanced Monitoring metrics, specify 0. The default is 0.

\n

If MonitoringRoleArn is specified, also set MonitoringInterval\n to a value other than 0.

\n

Valid Values: 0, 1, 5, 10, 15, 30, 60\n

\n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off \n collecting Enhanced Monitoring metrics, specify 0. The default is 0.

\n

If MonitoringRoleArn is specified, also set MonitoringInterval\n to a value other than 0.

\n

Valid Values: 0, 1, 5, 10, 15, 30, 60\n

\n

Valid for: Multi-AZ DB clusters only

" } }, "MonitoringRoleArn": { @@ -2356,13 +2356,13 @@ "EnablePerformanceInsights": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to turn on Performance Insights for the DB cluster.\n

\n

For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.\n

\n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

A value that indicates whether to turn on Performance Insights for the DB cluster.

\n

For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.

\n

Valid for: Multi-AZ DB clusters only

" } }, "PerformanceInsightsKMSKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

\n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

\n

Valid for: Multi-AZ DB clusters only

" } }, "PerformanceInsightsRetentionPeriod": { @@ -2393,7 +2393,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new DB cluster parameter group.

\n

Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.

\n

\n A DB cluster parameter group is initially created with the default parameters for the\n database engine used by instances in the DB cluster. To provide custom values for any of the\n parameters, you must modify the group after creating it using\n ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to\n associate it with your DB cluster using ModifyDBCluster.

\n

When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB\n instances in the DB cluster without failover for the new DB cluster parameter group and \n associated settings to take effect. \n

\n

When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB\n cluster without failover for the new DB cluster parameter group and associated settings to take effect. \n

\n \n

After you create a DB cluster parameter group, you should wait at least 5 minutes\n before creating your first DB cluster\n that uses that DB cluster parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter \n group is used as the default for a new DB cluster. This is especially important for parameters \n that are critical when creating the default database for a DB cluster, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBClusterParameters action to verify \n that your DB cluster parameter group has been created or modified.

\n \n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

Creates a new DB cluster parameter group.

\n

Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.

\n

A DB cluster parameter group is initially created with the default parameters for the\n database engine used by instances in the DB cluster. To provide custom values for any of the\n parameters, you must modify the group after creating it using\n ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to\n associate it with your DB cluster using ModifyDBCluster.

\n

When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB\n instances in the DB cluster without failover for the new DB cluster parameter group and \n associated settings to take effect.

\n

When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB\n cluster without failover for the new DB cluster parameter group and associated settings to take effect.

\n \n

After you create a DB cluster parameter group, you should wait at least 5 minutes\n before creating your first DB cluster\n that uses that DB cluster parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter \n group is used as the default for a new DB cluster. This is especially important for parameters \n that are critical when creating the default database for a DB cluster, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBClusterParameters action to verify \n that your DB cluster parameter group has been created or modified.

\n \n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

" } }, "com.amazonaws.rds#CreateDBClusterParameterGroupMessage": { @@ -2402,14 +2402,14 @@ "DBClusterParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the DB cluster parameter group.

\n

Constraints:

\n \n \n

This value is stored as a lowercase string.

\n ", + "smithy.api#documentation": "

The name of the DB cluster parameter group.

\n

Constraints:

\n \n \n

This value is stored as a lowercase string.

\n ", "smithy.api#required": {} } }, "DBParameterGroupFamily": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster \n parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.

\n

\n Aurora MySQL\n

\n

Example: aurora5.6, aurora-mysql5.7, aurora-mysql8.0\n

\n

\n Aurora PostgreSQL\n

\n

Example: aurora-postgresql9.6\n

\n

\n RDS for MySQL\n

\n

Example: mysql8.0\n

\n

\n RDS for PostgreSQL\n

\n

Example: postgres12\n

\n

To list all of the available parameter group families for a DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine \n

\n

For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine aurora-postgresql\n

\n \n

The output contains duplicates.

\n \n

The following are the valid DB engine values:

\n ", + "smithy.api#documentation": "

The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster \n parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.

\n

\n Aurora MySQL\n

\n

Example: aurora5.6, aurora-mysql5.7, aurora-mysql8.0\n

\n

\n Aurora PostgreSQL\n

\n

Example: aurora-postgresql9.6\n

\n

\n RDS for MySQL\n

\n

Example: mysql8.0\n

\n

\n RDS for PostgreSQL\n

\n

Example: postgres12\n

\n

To list all of the available parameter group families for a DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine \n

\n

For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine aurora-postgresql\n

\n \n

The output contains duplicates.

\n \n

The following are the valid DB engine values:

\n ", "smithy.api#required": {} } }, @@ -2473,7 +2473,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a snapshot of a DB cluster.

\n

For more information on Amazon Aurora, see What is Amazon\n Aurora? in the Amazon Aurora User Guide.\n

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

Creates a snapshot of a DB cluster.

\n

For more information on Amazon Aurora, see What is Amazon\n Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

" } }, "com.amazonaws.rds#CreateDBClusterSnapshotMessage": { @@ -2482,14 +2482,14 @@ "DBClusterSnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string.

\n

Constraints:

\n \n

Example: my-cluster1-snapshot1\n

", + "smithy.api#documentation": "

The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string.

\n

Constraints:

\n \n

Example: my-cluster1-snapshot1\n

", "smithy.api#required": {} } }, "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The identifier of the DB cluster to create a snapshot for. This parameter isn't case-sensitive.

\n

Constraints:

\n \n

Example: my-cluster1\n

", + "smithy.api#documentation": "

The identifier of the DB cluster to create a snapshot for. This parameter isn't case-sensitive.

\n

Constraints:

\n \n

Example: my-cluster1\n

", "smithy.api#required": {} } }, @@ -2589,142 +2589,142 @@ "DBName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The meaning of this parameter differs according to the database engine you use.

\n

\n MySQL\n

\n

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

\n

Constraints:

\n \n

\n MariaDB\n

\n

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

\n

Constraints:

\n \n

\n PostgreSQL\n

\n

The name of the database to create when the DB instance is created. If this parameter isn't specified, a database named postgres \n is created in the DB instance.

\n

Constraints:

\n \n

\n Oracle\n

\n

The Oracle System ID (SID) of the created DB instance.\n If you specify null, the default value ORCL is used.\n You can't specify the string NULL, or any other reserved word, for DBName. \n

\n

Default: ORCL\n

\n

Constraints:

\n \n

\n Amazon RDS Custom for Oracle\n

\n

The Oracle System ID (SID) of the created RDS Custom DB instance.\n If you don't specify a value, the default value is ORCL.\n

\n

Default: ORCL\n

\n

Constraints:

\n \n

\n Amazon RDS Custom for SQL Server\n

\n

Not applicable. Must be null.

\n

\n SQL Server\n

\n

Not applicable. Must be null.

\n

\n Amazon Aurora MySQL\n

\n

The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is\n created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created \n in the DB cluster.

\n

Constraints:

\n \n

\n Amazon Aurora PostgreSQL\n

\n

The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is\n created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, \n a database named postgres is created in the DB cluster.

\n

Constraints:

\n " + "smithy.api#documentation": "

The meaning of this parameter differs according to the database engine you use.

\n

\n MySQL\n

\n

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

\n

Constraints:

\n \n

\n MariaDB\n

\n

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

\n

Constraints:

\n \n

\n PostgreSQL\n

\n

The name of the database to create when the DB instance is created. If this parameter isn't specified, a database named postgres \n is created in the DB instance.

\n

Constraints:

\n \n

\n Oracle\n

\n

The Oracle System ID (SID) of the created DB instance.\n If you specify null, the default value ORCL is used.\n You can't specify the string NULL, or any other reserved word, for DBName.

\n

Default: ORCL\n

\n

Constraints:

\n \n

\n Amazon RDS Custom for Oracle\n

\n

The Oracle System ID (SID) of the created RDS Custom DB instance.\n If you don't specify a value, the default value is ORCL.

\n

Default: ORCL\n

\n

Constraints:

\n \n

\n Amazon RDS Custom for SQL Server\n

\n

Not applicable. Must be null.

\n

\n SQL Server\n

\n

Not applicable. Must be null.

\n

\n Amazon Aurora MySQL\n

\n

The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is\n created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created \n in the DB cluster.

\n

Constraints:

\n \n

\n Amazon Aurora PostgreSQL\n

\n

The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is\n created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, \n a database named postgres is created in the DB cluster.

\n

Constraints:

\n " } }, "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The DB instance identifier. This parameter is stored as a lowercase string.

\n

Constraints:

\n \n

Example: mydbinstance\n

", + "smithy.api#documentation": "

The DB instance identifier. This parameter is stored as a lowercase string.

\n

Constraints:

\n \n

Example: mydbinstance\n

", "smithy.api#required": {} } }, "AllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The amount of storage in gibibytes (GiB) to allocate for the DB instance.

\n

Type: Integer

\n

\n Amazon Aurora\n

\n

Not applicable. Aurora cluster volumes automatically grow as the amount of data in your \n database increases, though you are only charged for the space that you use in an Aurora cluster volume.

\n\n

\n Amazon RDS Custom\n

\n

Constraints to the amount of storage for each storage type are the following:\n

\n \n \n

\n MySQL\n

\n

Constraints to the amount of storage for each storage type are the following:\n

\n \n \n

\n MariaDB\n

\n

Constraints to the amount of storage for each storage type are the following:\n

\n \n \n

\n PostgreSQL\n

\n

Constraints to the amount of storage for each storage type are the following:\n

\n \n \n

\n Oracle\n

\n

Constraints to the amount of storage for each storage type are the following:\n

\n \n \n

\n SQL Server\n

\n

Constraints to the amount of storage for each storage type are the following:\n

\n " + "smithy.api#documentation": "

The amount of storage in gibibytes (GiB) to allocate for the DB instance.

\n

Type: Integer

\n

\n Amazon Aurora\n

\n

Not applicable. Aurora cluster volumes automatically grow as the amount of data in your \n database increases, though you are only charged for the space that you use in an Aurora cluster volume.

\n

\n Amazon RDS Custom\n

\n

Constraints to the amount of storage for each storage type are the following:

\n \n

\n MySQL\n

\n

Constraints to the amount of storage for each storage type are the following:

\n \n

\n MariaDB\n

\n

Constraints to the amount of storage for each storage type are the following:

\n \n

\n PostgreSQL\n

\n

Constraints to the amount of storage for each storage type are the following:

\n \n

\n Oracle\n

\n

Constraints to the amount of storage for each storage type are the following:

\n \n

\n SQL Server\n

\n

Constraints to the amount of storage for each storage type are the following:

\n " } }, "DBInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the DB instance, for example db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n

", + "smithy.api#documentation": "

The compute and memory capacity of the DB instance, for example db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.

", "smithy.api#required": {} } }, "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the database engine to be used for this instance.\n

\n \n

Not every database engine is available for every Amazon Web Services Region.\n

\n\n

Valid Values:\n

\n ", + "smithy.api#documentation": "

The name of the database engine to be used for this instance.

\n

Not every database engine is available for every Amazon Web Services Region.

\n

Valid Values:

\n ", "smithy.api#required": {} } }, "MasterUsername": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name for the master user.

\n\n

\n Amazon Aurora\n

\n

Not applicable. The name for the master user is managed by the DB cluster.\n

\n \n

\n Amazon RDS\n

\n

Constraints:

\n " + "smithy.api#documentation": "

The name for the master user.

\n

\n Amazon Aurora\n

\n

Not applicable. The name for the master user is managed by the DB cluster.

\n

\n Amazon RDS\n

\n

Constraints:

\n " } }, "MasterUserPassword": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".

\n\n

\n Amazon Aurora\n

\n

Not applicable. The password for the master user is managed by the DB\n cluster.

\n\n

\n MariaDB\n

\n

Constraints: Must contain from 8 to 41 characters.

\n\n

\n Microsoft SQL Server\n

\n

Constraints: Must contain from 8 to 128 characters.

\n \n

\n MySQL\n

\n

Constraints: Must contain from 8 to 41 characters.

\n\n

\n Oracle\n

\n

Constraints: Must contain from 8 to 30 characters.

\n\n

\n PostgreSQL\n

\n

Constraints: Must contain from 8 to 128 characters.

" + "smithy.api#documentation": "

The password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".

\n

\n Amazon Aurora\n

\n

Not applicable. The password for the master user is managed by the DB\n cluster.

\n

\n MariaDB\n

\n

Constraints: Must contain from 8 to 41 characters.

\n

\n Microsoft SQL Server\n

\n

Constraints: Must contain from 8 to 128 characters.

\n

\n MySQL\n

\n

Constraints: Must contain from 8 to 41 characters.

\n

\n Oracle\n

\n

Constraints: Must contain from 8 to 30 characters.

\n

\n PostgreSQL\n

\n

Constraints: Must contain from 8 to 128 characters.

" } }, "DBSecurityGroups": { "target": "com.amazonaws.rds#DBSecurityGroupNameList", "traits": { - "smithy.api#documentation": "

A list of DB security groups to associate with this DB instance.

\n

Default: The default DB security group for the database engine.

" + "smithy.api#documentation": "

A list of DB security groups to associate with this DB instance.

\n

Default: The default DB security group for the database engine.

" } }, "VpcSecurityGroupIds": { "target": "com.amazonaws.rds#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "

A list of Amazon EC2 VPC security groups to associate with this DB instance.

\n \n

\n Amazon Aurora\n

\n

Not applicable. The associated list of EC2 VPC security groups is managed by\n the DB cluster.

\n \n

Default: The default EC2 VPC security group for the DB subnet group's VPC.

" + "smithy.api#documentation": "

A list of Amazon EC2 VPC security groups to associate with this DB instance.

\n

\n Amazon Aurora\n

\n

Not applicable. The associated list of EC2 VPC security groups is managed by\n the DB cluster.

\n

Default: The default EC2 VPC security group for the DB subnet group's VPC.

" } }, "AvailabilityZone": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n The Availability Zone (AZ) where the database will be created. For information on\n Amazon Web Services Regions and Availability Zones, see \n Regions\n and Availability Zones.\n

\n

\n Amazon Aurora\n

\n

Not applicable. Availability Zones are managed by the DB cluster.\n

\n

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

\n

\n Example: us-east-1d\n

\n

\n Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. \n The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.\n

\n \n

If you're creating a DB instance in an RDS on VMware environment,\n specify the identifier of the custom Availability Zone to create the DB instance\n in.

\n

For more information about RDS on VMware, see the \n \n RDS on VMware User Guide.\n

\n " + "smithy.api#documentation": "

The Availability Zone (AZ) where the database will be created. For information on\n Amazon Web Services Regions and Availability Zones, see \n Regions\n and Availability Zones.

\n

\n Amazon Aurora\n

\n

Not applicable. Availability Zones are managed by the DB cluster.

\n

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

\n

Example: us-east-1d\n

\n

Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. \n The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.

\n \n

If you're creating a DB instance in an RDS on VMware environment,\n specify the identifier of the custom Availability Zone to create the DB instance\n in.

\n

For more information about RDS on VMware, see the \n \n RDS on VMware User Guide.\n

\n " } }, "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

A DB subnet group to associate with this DB instance.

\n

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

\n

Example: mydbsubnetgroup\n

" + "smithy.api#documentation": "

A DB subnet group to associate with this DB instance.

\n

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

\n

Example: mydbsubnetgroup\n

" } }, "PreferredMaintenanceWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The time range each week during which system maintenance can occur, \n in Universal Coordinated Time (UTC). \n For more information, see Amazon RDS Maintenance Window.\n

\n

\n Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week.\n

\n

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

\n

Constraints: Minimum 30-minute window.

" + "smithy.api#documentation": "

The time range each week during which system maintenance can occur, \n in Universal Coordinated Time (UTC). \n For more information, see Amazon RDS Maintenance Window.

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week.

\n

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

\n

Constraints: Minimum 30-minute window.

" } }, "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the DB parameter group to associate with this DB instance. If you do not specify a value, then \n the default DB parameter group for the specified DB engine and version is used.

\n

This setting doesn't apply to RDS Custom.

\n

Constraints:

\n " + "smithy.api#documentation": "

The name of the DB parameter group to associate with this DB instance. If you do not specify a value, then \n the default DB parameter group for the specified DB engine and version is used.

\n

This setting doesn't apply to RDS Custom.

\n

Constraints:

\n " } }, "BackupRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of days for which automated backups are retained. Setting this parameter to a positive number enables \n backups. Setting this parameter to 0 disables automated backups.

\n

\n Amazon Aurora\n

\n

Not applicable. The retention period for automated backups is managed by the DB cluster.

\n

Default: 1

\n

Constraints:

\n " + "smithy.api#documentation": "

The number of days for which automated backups are retained. Setting this parameter to a positive number enables \n backups. Setting this parameter to 0 disables automated backups.

\n

\n Amazon Aurora\n

\n

Not applicable. The retention period for automated backups is managed by the DB cluster.

\n

Default: 1

\n

Constraints:

\n " } }, "PreferredBackupWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.\n The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.\n

\n \n

\n Amazon Aurora\n

\n

Not applicable. The daily time range for creating automated backups is managed by\n the DB cluster.

\n \n

Constraints:

\n " + "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.\n The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.

\n

\n Amazon Aurora\n

\n

Not applicable. The daily time range for creating automated backups is managed by\n the DB cluster.

\n

Constraints:

\n " } }, "Port": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

\n MySQL\n

\n

\n Default: 3306\n

\n

Valid values: 1150-65535\n

\n

Type: Integer

\n

\n MariaDB\n

\n

\n Default: 3306\n

\n

Valid values: 1150-65535\n

\n

Type: Integer

\n

\n PostgreSQL\n

\n

\n Default: 5432\n

\n

Valid values: 1150-65535\n

\n

Type: Integer

\n

\n Oracle\n

\n

\n Default: 1521\n

\n

Valid values: 1150-65535\n

\n

\n SQL Server\n

\n

\n Default: 1433\n

\n

Valid values: 1150-65535 except 1234, 1434,\n 3260, 3343, 3389, 47001, and\n 49152-49156.

\n

\n Amazon Aurora\n

\n

\n Default: 3306\n

\n

Valid values: 1150-65535\n

\n

Type: Integer

" + "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

\n MySQL\n

\n

Default: 3306\n

\n

Valid values: 1150-65535\n

\n

Type: Integer

\n

\n MariaDB\n

\n

Default: 3306\n

\n

Valid values: 1150-65535\n

\n

Type: Integer

\n

\n PostgreSQL\n

\n

Default: 5432\n

\n

Valid values: 1150-65535\n

\n

Type: Integer

\n

\n Oracle\n

\n

Default: 1521\n

\n

Valid values: 1150-65535\n

\n

\n SQL Server\n

\n

Default: 1433\n

\n

Valid values: 1150-65535 except 1234, 1434,\n 3260, 3343, 3389, 47001, and\n 49152-49156.

\n

\n Amazon Aurora\n

\n

Default: 3306\n

\n

Valid values: 1150-65535\n

\n

Type: Integer

" } }, "MultiAZ": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is a Multi-AZ deployment. You can't set \n the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

A value that indicates whether the DB instance is a Multi-AZ deployment. You can't set \n the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

\n

This setting doesn't apply to RDS Custom.

" } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The version number of the database engine to use.

\n

For a list of valid engine versions, use the DescribeDBEngineVersions action.

\n

The following are the database engines and links to information about the major and minor versions that are available with \n Amazon RDS. Not every database engine is available for every Amazon Web Services Region.

\n \n

\n Amazon Aurora\n

\n

Not applicable. The version number of the database engine to be used by the DB\n instance is managed by the DB cluster.

\n \n

\n Amazon RDS Custom for Oracle\n

\n

A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV \n name has the following format: 19.customized_string\n . An example identifier is \n 19.my_cev1. For more information, see \n Creating an RDS Custom for Oracle DB instance in the Amazon RDS User Guide..

\n \n

\n Amazon RDS Custom for SQL Server\n

\n

See RDS Custom for SQL Server general requirements \n in the Amazon RDS User Guide.\n

\n \n

\n MariaDB\n

\n

For information, see MariaDB on Amazon RDS Versions in the \n Amazon RDS User Guide.\n

\n \n

\n Microsoft SQL Server\n

\n

For information, see Microsoft SQL Server Versions on Amazon RDS in the \n Amazon RDS User Guide.\n

\n \n

\n MySQL\n

\n

For information, see MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.\n

\n \n

\n Oracle\n

\n

For information, see Oracle Database Engine Release Notes in the \n Amazon RDS User Guide.\n

\n\n

\n PostgreSQL\n

\n

For information, see Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

The version number of the database engine to use.

\n

For a list of valid engine versions, use the DescribeDBEngineVersions action.

\n

The following are the database engines and links to information about the major and minor versions that are available with \n Amazon RDS. Not every database engine is available for every Amazon Web Services Region.

\n

\n Amazon Aurora\n

\n

Not applicable. The version number of the database engine to be used by the DB\n instance is managed by the DB cluster.

\n

\n Amazon RDS Custom for Oracle\n

\n

A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV \n name has the following format: 19.customized_string\n . An example identifier is \n 19.my_cev1. For more information, see \n Creating an RDS Custom for Oracle DB instance in the Amazon RDS User Guide.

\n

\n Amazon RDS Custom for SQL Server\n

\n

See RDS Custom for SQL Server general requirements \n in the Amazon RDS User Guide.

\n

\n MariaDB\n

\n

For information, see MariaDB on Amazon RDS Versions in the \n Amazon RDS User Guide.

\n

\n Microsoft SQL Server\n

\n

For information, see Microsoft SQL Server Versions on Amazon RDS in the \n Amazon RDS User Guide.

\n

\n MySQL\n

\n

For information, see MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.

\n

\n Oracle\n

\n

For information, see Oracle Database Engine Release Notes in the \n Amazon RDS User Guide.

\n

\n PostgreSQL\n

\n

For information, see Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.

" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. \n By default, minor engine upgrades are applied automatically.

\n

If you create an RDS Custom DB instance, you must set AutoMinorVersionUpgrade to \n false.

" + "smithy.api#documentation": "

A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. \n By default, minor engine upgrades are applied automatically.

\n

If you create an RDS Custom DB instance, you must set AutoMinorVersionUpgrade to \n false.

" } }, "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

License model information for this DB instance.

\n

\n Valid values: license-included | bring-your-own-license | general-public-license\n

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

License model information for this DB instance.

\n

Valid values: license-included | bring-your-own-license | general-public-license\n

\n

This setting doesn't apply to RDS Custom.

" } }, "Iops": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.\n For information about valid Iops values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide.\n

\n

Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 \n of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50 \n of the storage amount for the DB instance.\n

" + "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.\n For information about valid Iops values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide.

\n

Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 \n of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50 \n of the storage amount for the DB instance.

" } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

A value that indicates that the DB instance should be associated with the specified option group.

\n

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed \n from an option group. Also, that option group can't be removed from a DB instance after it is \n associated with a DB instance.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

A value that indicates that the DB instance should be associated with the specified option group.

\n

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed \n from an option group. Also, that option group can't be removed from a DB instance after it is \n associated with a DB instance.

\n

This setting doesn't apply to RDS Custom.

" } }, "CharacterSetName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

For supported engines, this value indicates that the DB instance should be associated with the \n specified CharacterSet.

\n

This setting doesn't apply to RDS Custom. However, if you need to change the character set, \n you can change it on the database itself.

\n

\n Amazon Aurora\n

\n

Not applicable. The character set is managed by\n the DB cluster. For more information, see CreateDBCluster.

" + "smithy.api#documentation": "

For supported engines, this value indicates that the DB instance should be associated with the \n specified CharacterSet.

\n

This setting doesn't apply to RDS Custom. However, if you need to change the character set, \n you can change it on the database itself.

\n

\n Amazon Aurora\n

\n

Not applicable. The character set is managed by\n the DB cluster. For more information, see CreateDBCluster.

" } }, "NcharCharacterSetName": { @@ -2736,7 +2736,7 @@ "PubliclyAccessible": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is publicly accessible.

\n

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from \n within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. \n Access to the DB instance is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

\n

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n " + "smithy.api#documentation": "

A value that indicates whether the DB instance is publicly accessible.

\n

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from \n within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. \n Access to the DB instance is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

\n

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n " } }, "Tags": { @@ -2748,97 +2748,97 @@ "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The identifier of the DB cluster that the instance will belong to.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The identifier of the DB cluster that the instance will belong to.

\n

This setting doesn't apply to RDS Custom.

" } }, "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.

\n

\n Valid values: standard | gp2 | io1\n

\n

\n If you specify io1, you must also include a value for the\n Iops parameter.\n

\n

\n Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

" + "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.

\n

Valid values: standard | gp2 | io1\n

\n

If you specify io1, you must also include a value for the\n Iops parameter.

\n

Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

" } }, "TdeCredentialArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The ARN from the key store with which to associate the instance for TDE encryption.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The ARN from the key store with which to associate the instance for TDE encryption.

\n

This setting doesn't apply to RDS Custom.

" } }, "TdeCredentialPassword": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The password for the given ARN from the key store in order to access the device.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The password for the given ARN from the key store in order to access the device.

\n

This setting doesn't apply to RDS Custom.

" } }, "StorageEncrypted": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.

\n

For RDS Custom instances, either set this parameter to true or leave it unset. \n If you set this parameter to false, RDS reports an error.

\n

\n Amazon Aurora\n

\n

Not applicable. The encryption for DB instances is managed by the DB cluster.

" + "smithy.api#documentation": "

A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.

\n

For RDS Custom instances, either set this parameter to true or leave it unset. \n If you set this parameter to false, RDS reports an error.

\n

\n Amazon Aurora\n

\n

Not applicable. The encryption for DB instances is managed by the DB cluster.

" } }, "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB instance.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

\n Amazon Aurora\n

\n

Not applicable. The Amazon Web Services KMS key identifier is managed by\n the DB cluster. For more information, see CreateDBCluster.

\n

If StorageEncrypted is enabled, and you do\n not specify a value for the KmsKeyId parameter, then\n Amazon RDS uses your default KMS key. There is a \n default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different\n default KMS key for each Amazon Web Services Region.

\n

\n Amazon RDS Custom\n

\n

A KMS key is required for RDS Custom instances. For most RDS engines, if you leave this parameter empty \n while enabling StorageEncrypted, the engine uses the default KMS key. However, RDS Custom \n doesn't use the default key when this parameter is empty. You must explicitly specify a key.

" + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB instance.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

\n Amazon Aurora\n

\n

Not applicable. The Amazon Web Services KMS key identifier is managed by\n the DB cluster. For more information, see CreateDBCluster.

\n

If StorageEncrypted is enabled, and you do\n not specify a value for the KmsKeyId parameter, then\n Amazon RDS uses your default KMS key. There is a \n default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different\n default KMS key for each Amazon Web Services Region.

\n

\n Amazon RDS Custom\n

\n

A KMS key is required for RDS Custom instances. For most RDS engines, if you leave this parameter empty \n while enabling StorageEncrypted, the engine uses the default KMS key. However, RDS Custom \n doesn't use the default key when this parameter is empty. You must explicitly specify a key.

" } }, "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" } }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

\n

\n Amazon Aurora\n

\n

Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting.

" + "smithy.api#documentation": "

A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

\n

\n Amazon Aurora\n

\n

Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting.

" } }, "MonitoringInterval": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for \n the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0.

\n

If MonitoringRoleArn is specified, then you must set MonitoringInterval\n to a value other than 0.

\n

This setting doesn't apply to RDS Custom.

\n

Valid Values: 0, 1, 5, 10, 15, 30, 60\n

" + "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for \n the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0.

\n

If MonitoringRoleArn is specified, then you must set MonitoringInterval\n to a value other than 0.

\n

This setting doesn't apply to RDS Custom.

\n

Valid Values: 0, 1, 5, 10, 15, 30, 60\n

" } }, "MonitoringRoleArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see Setting Up and Enabling Enhanced Monitoring \n in the Amazon RDS User Guide.

\n

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see Setting Up and Enabling Enhanced Monitoring \n in the Amazon RDS User Guide.

\n

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

\n

This setting doesn't apply to RDS Custom.

" } }, "DomainIAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

\n

This setting doesn't apply to RDS Custom.

" } }, "PromotionTier": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

A value that specifies the order in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide. \n

\n

This setting doesn't apply to RDS Custom.

\n

Default: 1

\n

Valid Values: 0 - 15

" + "smithy.api#documentation": "

A value that specifies the order in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

\n

This setting doesn't apply to RDS Custom.

\n

Default: 1

\n

Valid Values: 0 - 15

" } }, "Timezone": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The time zone of the DB instance. \n The time zone parameter is currently supported only by\n Microsoft SQL Server.\n

" + "smithy.api#documentation": "

The time zone of the DB instance. \n The time zone parameter is currently supported only by\n Microsoft SQL Server.

" } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora. In Aurora, mapping Amazon Web Services IAM accounts \n to database accounts is managed by the DB cluster.

\n

For more information, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora. In Aurora, mapping Amazon Web Services IAM accounts \n to database accounts is managed by the DB cluster.

\n

For more information, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

" } }, "EnablePerformanceInsights": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable Performance Insights for the DB instance. For more information, see \n Using Amazon Performance Insights in the Amazon Relational Database Service\n User Guide.\n

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

A value that indicates whether to enable Performance Insights for the DB instance. For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" } }, "PerformanceInsightsKMSKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

\n

This setting doesn't apply to RDS Custom.

" } }, "PerformanceInsightsRetentionPeriod": { @@ -2850,7 +2850,7 @@ "EnableCloudwatchLogsExports": { "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "

The list of log types that need to be enabled for exporting to CloudWatch Logs. The values\n in the list depend on the DB engine. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database\n Service User Guide.

\n

\n Amazon Aurora\n

\n

Not applicable. CloudWatch Logs exports are managed by the DB cluster.\n

\n

\n RDS Custom\n

\n

Not applicable.\n

\n

\n MariaDB\n

\n

Possible values are audit, error, general, and slowquery. \n

\n

\n Microsoft SQL Server\n

\n

Possible values are agent and error.\n

\n

\n MySQL\n

\n

Possible values are audit, error, general, and slowquery. \n

\n

\n Oracle\n

\n

Possible values are alert, audit, listener, trace, and\n oemagent.\n

\n

\n PostgreSQL\n

\n

Possible values are postgresql and upgrade.\n

" + "smithy.api#documentation": "

The list of log types that need to be enabled for exporting to CloudWatch Logs. The values\n in the list depend on the DB engine. For more information, see \n \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

\n Amazon Aurora\n

\n

Not applicable. CloudWatch Logs exports are managed by the DB cluster.

\n

\n RDS Custom\n

\n

Not applicable.

\n

\n MariaDB\n

\n

Possible values are audit, error, general, and slowquery.

\n

\n Microsoft SQL Server\n

\n

Possible values are agent and error.

\n

\n MySQL\n

\n

Possible values are audit, error, general, and slowquery.

\n

\n Oracle\n

\n

Possible values are alert, audit, listener, trace, and\n oemagent.

\n

\n PostgreSQL\n

\n

Possible values are postgresql and upgrade.

" } }, "ProcessorFeatures": { @@ -2862,7 +2862,7 @@ "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.\n

\n

\n Amazon Aurora\n

\n

Not applicable. You can enable or disable deletion protection for the DB cluster. \n For more information, see CreateDBCluster. DB instances in a DB \n cluster can be deleted even when deletion protection is enabled for the DB cluster.\n

" + "smithy.api#documentation": "

A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

\n

\n Amazon Aurora\n

\n

Not applicable. You can enable or disable deletion protection for the DB cluster. \n For more information, see CreateDBCluster. DB instances in a DB \n cluster can be deleted even when deletion protection is enabled for the DB cluster.

" } }, "MaxAllocatedStorage": { @@ -2880,7 +2880,7 @@ "CustomIamInstanceProfile": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n \n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon Relational Database Service\n User Guide.

\n

This setting is required for RDS Custom.

" + "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n \n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

\n

This setting is required for RDS Custom.

" } }, "BackupTarget": { @@ -2962,7 +2962,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new DB instance that acts as a read replica for an existing source DB\n instance. You can create a read replica for a DB instance running MySQL, MariaDB,\n Oracle, PostgreSQL, or SQL Server. For more information, see Working with Read\n Replicas in the Amazon RDS User Guide.

\n\n

Amazon Aurora doesn't support this action. Call the CreateDBInstance\n action to create a DB instance for an Aurora DB cluster.

\n\n

All read replica DB instances are created with backups disabled. All other DB\n instance attributes (including DB security groups and DB parameter groups) are inherited\n from the source DB instance, except as specified.

\n\n \n

Your source DB instance must have backup retention enabled.\n

\n " + "smithy.api#documentation": "

Creates a new DB instance that acts as a read replica for an existing source DB\n instance. You can create a read replica for a DB instance running MySQL, MariaDB,\n Oracle, PostgreSQL, or SQL Server. For more information, see Working with Read\n Replicas in the Amazon RDS User Guide.

\n

Amazon Aurora doesn't support this action. Call the CreateDBInstance\n action to create a DB instance for an Aurora DB cluster.

\n

All read replica DB instances are created with backups disabled. All other DB\n instance attributes (including DB security groups and DB parameter groups) are inherited\n from the source DB instance, except as specified.

\n \n

Your source DB instance must have backup retention enabled.

\n " } }, "com.amazonaws.rds#CreateDBInstanceReadReplicaMessage": { @@ -2978,38 +2978,38 @@ "SourceDBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The identifier of the DB instance that will act as the source for the read replica.\n Each DB instance can have up to five read replicas.

\n

Constraints:

\n ", + "smithy.api#documentation": "

The identifier of the DB instance that will act as the source for the read replica.\n Each DB instance can have up to five read replicas.

\n

Constraints:

\n ", "smithy.api#required": {} } }, "DBInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the read replica, for example\n db.m4.large. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines. For the full list of DB instance classes, and\n availability for your engine, see DB Instance\n Class in the Amazon RDS User Guide.\n

\n

Default: Inherits from the source DB instance.

" + "smithy.api#documentation": "

The compute and memory capacity of the read replica, for example\n db.m4.large. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines. For the full list of DB instance classes, and\n availability for your engine, see DB Instance\n Class in the Amazon RDS User Guide.

\n

Default: Inherits from the source DB instance.

" } }, "AvailabilityZone": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Availability Zone (AZ) where the read replica will be created.

\n

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

\n

\n Example: us-east-1d\n

" + "smithy.api#documentation": "

The Availability Zone (AZ) where the read replica will be created.

\n

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

\n

Example: us-east-1d\n

" } }, "Port": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The port number that the DB instance uses for connections.

\n

Default: Inherits from the source DB instance

\n

Valid Values: 1150-65535\n

" + "smithy.api#documentation": "

The port number that the DB instance uses for connections.

\n

Default: Inherits from the source DB instance

\n

Valid Values: 1150-65535\n

" } }, "MultiAZ": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the read replica is in a Multi-AZ deployment.

\n \n

You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of\n your replica in another Availability Zone for failover support for the replica. Creating\n your read replica as a Multi-AZ DB instance is independent of whether the source\n database is a Multi-AZ DB instance.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

A value that indicates whether the read replica is in a Multi-AZ deployment.

\n

You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of\n your replica in another Availability Zone for failover support for the replica. Creating\n your read replica as a Multi-AZ DB instance is independent of whether the source\n database is a Multi-AZ DB instance.

\n

This setting doesn't apply to RDS Custom.

" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether minor engine upgrades are applied automatically to the\n read replica during the maintenance window.

\n

This setting doesn't apply to RDS Custom.

\n

Default: Inherits from the source DB instance

" + "smithy.api#documentation": "

A value that indicates whether minor engine upgrades are applied automatically to the\n read replica during the maintenance window.

\n

This setting doesn't apply to RDS Custom.

\n

Default: Inherits from the source DB instance

" } }, "Iops": { @@ -3021,19 +3021,19 @@ "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The option group the DB instance is associated with. If omitted, the option group associated with the source instance is used.

\n \n

For SQL Server, you must use the option group associated with the source\n instance.

\n \n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The option group the DB instance is associated with. If omitted, the option group associated with the source instance is used.

\n \n

For SQL Server, you must use the option group associated with the source\n instance.

\n \n

This setting doesn't apply to RDS Custom.

" } }, "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the DB parameter group to associate with this DB instance.

\n

If you do not specify a value for DBParameterGroupName, then Amazon RDS\n uses the DBParameterGroup of source DB instance for a same Region read\n replica, or the default DBParameterGroup for the specified DB engine for a\n cross-Region read replica.

\n

Specifying a parameter group for this operation is only supported for Oracle DB instances. It \n isn't supported for RDS Custom.

\n

Constraints:

\n " + "smithy.api#documentation": "

The name of the DB parameter group to associate with this DB instance.

\n

If you do not specify a value for DBParameterGroupName, then Amazon RDS\n uses the DBParameterGroup of source DB instance for a same Region read\n replica, or the default DBParameterGroup for the specified DB engine for a\n cross-Region read replica.

\n

Specifying a parameter group for this operation is only supported for Oracle DB instances. It \n isn't supported for RDS Custom.

\n

Constraints:

\n " } }, "PubliclyAccessible": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

" + "smithy.api#documentation": "

A value that indicates whether the DB instance is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

" } }, "Tags": { @@ -3042,19 +3042,19 @@ "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC.

\n

Constraints:

\n \n

Example: mydbsubnetgroup\n

" + "smithy.api#documentation": "

Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC.

\n

Constraints:

\n \n

Example: mydbsubnetgroup\n

" } }, "VpcSecurityGroupIds": { "target": "com.amazonaws.rds#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "

A list of Amazon EC2 VPC security groups to associate with the read replica.

\n

This setting doesn't apply to RDS Custom.

\n

\n Default: The default EC2 VPC security group for the DB subnet group's VPC.\n

" + "smithy.api#documentation": "

A list of Amazon EC2 VPC security groups to associate with the read replica.

\n

This setting doesn't apply to RDS Custom.

\n

Default: The default EC2 VPC security group for the DB subnet group's VPC.

" } }, "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the read replica.

\n

\n Valid values: standard | gp2 | io1\n

\n

\n If you specify io1, you must also include a value for the\n Iops parameter.\n

\n

\n Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

" + "smithy.api#documentation": "

Specifies the storage type to be associated with the read replica.

\n

Valid values: standard | gp2 | io1\n

\n

If you specify io1, you must also include a value for the\n Iops parameter.

\n

Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

" } }, "CopyTagsToSnapshot": { @@ -3066,37 +3066,37 @@ "MonitoringInterval": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are\n collected for the read replica. To disable collecting Enhanced Monitoring metrics,\n specify 0. The default is 0.

\n

If MonitoringRoleArn is specified, then you must also set MonitoringInterval\n to a value other than 0.

\n

This setting doesn't apply to RDS Custom.

\n

Valid Values: 0, 1, 5, 10, 15, 30, 60\n

" + "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are\n collected for the read replica. To disable collecting Enhanced Monitoring metrics,\n specify 0. The default is 0.

\n

If MonitoringRoleArn is specified, then you must also set MonitoringInterval\n to a value other than 0.

\n

This setting doesn't apply to RDS Custom.

\n

Valid Values: 0, 1, 5, 10, 15, 30, 60\n

" } }, "MonitoringRoleArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n go to To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

\n

If MonitoringInterval is set to a value other than 0, then you must \n supply a MonitoringRoleArn value.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n go to To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

\n

If MonitoringInterval is set to a value other than 0, then you must \n supply a MonitoringRoleArn value.

\n

This setting doesn't apply to RDS Custom.

" } }, "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted read replica.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you create an encrypted read replica in the same Amazon Web Services Region as the source DB\n instance, then do not specify a value for this parameter. A read replica in the same Amazon Web Services Region\n is always encrypted with the same KMS key as the source DB instance.

\n

If you create an encrypted read replica in a different Amazon Web Services Region, then you must\n specify a KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to\n the Amazon Web Services Region that they are created in, and you can't use KMS keys from one\n Amazon Web Services Region in another Amazon Web Services Region.

\n

You can't create an encrypted read replica from an unencrypted DB instance.

\n

This setting doesn't apply to RDS Custom, which uses the same KMS key as the primary \n replica.

" + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted read replica.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you create an encrypted read replica in the same Amazon Web Services Region as the source DB\n instance, then do not specify a value for this parameter. A read replica in the same Amazon Web Services Region\n is always encrypted with the same KMS key as the source DB instance.

\n

If you create an encrypted read replica in a different Amazon Web Services Region, then you must\n specify a KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to\n the Amazon Web Services Region that they are created in, and you can't use KMS keys from one\n Amazon Web Services Region in another Amazon Web Services Region.

\n

You can't create an encrypted read replica from an unencrypted DB instance.

\n

This setting doesn't apply to RDS Custom, which uses the same KMS key as the primary \n replica.

" } }, "PreSignedUrl": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action \n in the source Amazon Web Services Region that contains the source DB instance.\n

\n \n

You must specify this parameter when you create an encrypted read replica from\n another Amazon Web Services Region by using the Amazon RDS API. Don't specify\n PreSignedUrl when you are creating an encrypted read replica in the\n same Amazon Web Services Region.

\n \n

The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action \n that can be executed in the source Amazon Web Services Region that contains the encrypted source DB instance. \n The presigned URL request must contain the following parameter values:\n

\n \n \n \n

To learn how to generate a Signature Version 4 signed request, see \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n Signature Version 4 Signing Process.\n

\n \n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can be executed in the source Amazon Web Services Region.

\n

\n SourceRegion isn't supported for SQL Server, because SQL Server on Amazon RDS\n doesn't support cross-Region read replicas.

\n \n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action \n in the source Amazon Web Services Region that contains the source DB instance.

\n

You must specify this parameter when you create an encrypted read replica from\n another Amazon Web Services Region by using the Amazon RDS API. Don't specify\n PreSignedUrl when you are creating an encrypted read replica in the\n same Amazon Web Services Region.

\n

The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action \n that can be executed in the source Amazon Web Services Region that contains the encrypted source DB instance. \n The presigned URL request must contain the following parameter values:

\n \n

To learn how to generate a Signature Version 4 signed request, see \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can be executed in the source Amazon Web Services Region.

\n

\n SourceRegion isn't supported for SQL Server, because SQL Server on Amazon RDS\n doesn't support cross-Region read replicas.

\n \n

This setting doesn't apply to RDS Custom.

" } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n \n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" } }, "EnablePerformanceInsights": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable Performance Insights for the read replica.

\n

For more information, see Using\n Amazon Performance Insights in the Amazon RDS User Guide.\n

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

A value that indicates whether to enable Performance Insights for the read replica.

\n

For more information, see Using\n Amazon Performance Insights in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" } }, "PerformanceInsightsKMSKeyId": { @@ -3108,7 +3108,7 @@ "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

\n

This setting doesn't apply to RDS Custom.

" } }, "EnableCloudwatchLogsExports": { @@ -3132,7 +3132,7 @@ "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.\n

" + "smithy.api#documentation": "

A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

" } }, "Domain": { @@ -3162,7 +3162,7 @@ "CustomIamInstanceProfile": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n \n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon Relational Database Service\n User Guide.

\n

This setting is required for RDS Custom.

" + "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n \n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

\n

This setting is required for RDS Custom.

" } } } @@ -3200,7 +3200,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new DB parameter group.

\n

\n A DB parameter group is initially created with the default parameters for the\n database engine used by the DB instance. To provide custom values for any of the\n parameters, you must modify the group after creating it using\n ModifyDBParameterGroup. Once you've created a DB parameter group, you need to\n associate it with your DB instance using ModifyDBInstance. When you associate\n a new DB parameter group with a running DB instance, you need to reboot the DB\n instance without failover for the new DB parameter group and associated settings to take effect. \n

\n

This command doesn't apply to RDS Custom.

\n \n

After you create a DB parameter group, you should wait at least 5 minutes\n before creating your first DB instance that uses that DB parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the create action before the parameter \n group is used as the default for a new DB instance. This is especially important for parameters \n that are critical when creating the default database for a DB instance, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBParameters command to verify \n that your DB parameter group has been created or modified.

\n " + "smithy.api#documentation": "

Creates a new DB parameter group.

\n

A DB parameter group is initially created with the default parameters for the\n database engine used by the DB instance. To provide custom values for any of the\n parameters, you must modify the group after creating it using\n ModifyDBParameterGroup. Once you've created a DB parameter group, you need to\n associate it with your DB instance using ModifyDBInstance. When you associate\n a new DB parameter group with a running DB instance, you need to reboot the DB\n instance without failover for the new DB parameter group and associated settings to take effect.

\n

This command doesn't apply to RDS Custom.

\n \n

After you create a DB parameter group, you should wait at least 5 minutes\n before creating your first DB instance that uses that DB parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the create action before the parameter \n group is used as the default for a new DB instance. This is especially important for parameters \n that are critical when creating the default database for a DB instance, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBParameters command to verify \n that your DB parameter group has been created or modified.

\n " } }, "com.amazonaws.rds#CreateDBParameterGroupMessage": { @@ -3209,14 +3209,14 @@ "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the DB parameter group.

\n

Constraints:

\n \n \n

This value is stored as a lowercase string.

\n ", + "smithy.api#documentation": "

The name of the DB parameter group.

\n

Constraints:

\n \n \n

This value is stored as a lowercase string.

\n ", "smithy.api#required": {} } }, "DBParameterGroupFamily": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.

\n

To list all of the available parameter group families for a DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine \n

\n

For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine mysql\n

\n \n

The output contains duplicates.

\n \n

The following are the valid DB engine values:

\n ", + "smithy.api#documentation": "

The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.

\n

To list all of the available parameter group families for a DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine \n

\n

For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine mysql\n

\n \n

The output contains duplicates.

\n \n

The following are the valid DB engine values:

\n ", "smithy.api#required": {} } }, @@ -3295,7 +3295,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Creates a DBProxyEndpoint. Only applies to proxies that are associated with Aurora DB clusters.\n You can use DB proxy endpoints to specify read/write or read-only access to the DB cluster. You can also use\n DB proxy endpoints to access a DB proxy through a different VPC than the proxy's default VPC.\n

" + "smithy.api#documentation": "

Creates a DBProxyEndpoint. Only applies to proxies that are associated with Aurora DB clusters.\n You can use DB proxy endpoints to specify read/write or read-only access to the DB cluster. You can also use\n DB proxy endpoints to access a DB proxy through a different VPC than the proxy's default VPC.

" } }, "com.amazonaws.rds#CreateDBProxyEndpointRequest": { @@ -3451,7 +3451,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new DB security group. DB security groups control access to a DB instance.

\n \n

A DB security group controls access to EC2-Classic DB instances that are not in a VPC.

\n " + "smithy.api#documentation": "

Creates a new DB security group. DB security groups control access to a DB instance.

\n \n

A DB security group controls access to EC2-Classic DB instances that are not in a VPC.

\n " } }, "com.amazonaws.rds#CreateDBSecurityGroupMessage": { @@ -3460,7 +3460,7 @@ "DBSecurityGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name for the DB security group. This value is stored as a lowercase string.

\n

Constraints:

\n \n

Example: mysecuritygroup\n

", + "smithy.api#documentation": "

The name for the DB security group. This value is stored as a lowercase string.

\n

Constraints:

\n \n

Example: mysecuritygroup\n

", "smithy.api#required": {} } }, @@ -3522,14 +3522,14 @@ "DBSnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The identifier for the DB snapshot.

\n

Constraints:

\n \n

Example: my-snapshot-id\n

", + "smithy.api#documentation": "

The identifier for the DB snapshot.

\n

Constraints:

\n \n

Example: my-snapshot-id\n

", "smithy.api#required": {} } }, "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The identifier of the DB instance that you want to create the snapshot of.

\n

Constraints:

\n ", + "smithy.api#documentation": "

The identifier of the DB instance that you want to create the snapshot of.

\n

Constraints:

\n ", "smithy.api#required": {} } }, @@ -3584,7 +3584,7 @@ "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name for the DB subnet group. This value is stored as a lowercase string.

\n

Constraints:

\n \n

Example: mydbsubnetgroup\n

", + "smithy.api#documentation": "

The name for the DB subnet group. This value is stored as a lowercase string.

\n

Constraints:

\n \n

Example: mydbsubnetgroup\n

", "smithy.api#required": {} } }, @@ -3653,7 +3653,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an RDS event notification subscription. This action requires a topic Amazon\n Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API.\n To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the\n topic. The ARN is displayed in the SNS console.

\n

You can specify the type of source (SourceType) that you want to be\n notified of and provide a list of RDS sources (SourceIds) that triggers the\n events. You can also provide a list of event categories (EventCategories)\n for events that you want to be notified of. For example, you can specify\n SourceType = db-instance, SourceIds =\n mydbinstance1, mydbinstance2 and\n EventCategories = Availability,\n Backup.

\n\n

If you specify both the SourceType and SourceIds, such as SourceType = db-instance\n and SourceIds = myDBInstance1, you are notified of all the db-instance events for\n the specified source. If you specify a SourceType but do not specify SourceIds,\n you receive notice of the events for that source type for all your RDS sources. If you\n don't specify either the SourceType or the SourceIds, you are notified of events\n generated from all RDS sources belonging to your customer account.

\n \n

RDS event notification is only available for unencrypted SNS topics. If you specify an \n encrypted SNS topic, event notifications aren't sent for the topic.

\n " + "smithy.api#documentation": "

Creates an RDS event notification subscription. This action requires a topic Amazon\n Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API.\n To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the\n topic. The ARN is displayed in the SNS console.

\n

You can specify the type of source (SourceType) that you want to be\n notified of and provide a list of RDS sources (SourceIds) that triggers the\n events. You can also provide a list of event categories (EventCategories)\n for events that you want to be notified of. For example, you can specify\n SourceType = db-instance, SourceIds =\n mydbinstance1, mydbinstance2 and\n EventCategories = Availability,\n Backup.

\n

If you specify both the SourceType and SourceIds, such as SourceType = db-instance\n and SourceIds = myDBInstance1, you are notified of all the db-instance events for\n the specified source. If you specify a SourceType but do not specify SourceIds,\n you receive notice of the events for that source type for all your RDS sources. If you\n don't specify either the SourceType or the SourceIds, you are notified of events\n generated from all RDS sources belonging to your customer account.

\n \n

RDS event notification is only available for unencrypted SNS topics. If you specify an \n encrypted SNS topic, event notifications aren't sent for the topic.

\n " } }, "com.amazonaws.rds#CreateEventSubscriptionMessage": { @@ -3662,7 +3662,7 @@ "SubscriptionName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the subscription.

\n

Constraints: The name must be less than 255 characters.

", + "smithy.api#documentation": "

The name of the subscription.

\n

Constraints: The name must be less than 255 characters.

", "smithy.api#required": {} } }, @@ -3676,25 +3676,25 @@ "SourceType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The type of source that is generating the events. For example, if you want to be\n notified of events generated by a DB instance, you set this parameter to\n db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are\n returned.

\n

Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n

" + "smithy.api#documentation": "

The type of source that is generating the events. For example, if you want to be\n notified of events generated by a DB instance, you set this parameter to\n db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are\n returned.

\n

Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n

" } }, "EventCategories": { "target": "com.amazonaws.rds#EventCategoriesList", "traits": { - "smithy.api#documentation": "

A list of event categories for a particular source type (SourceType)\n that you want to subscribe to. You can see a list of the categories for a given source type in the \"Amazon RDS event categories and event messages\" section of the \n Amazon RDS User Guide\n or the\n \n Amazon Aurora User Guide\n .\n\t\t\t\tYou can also see this list by using the DescribeEventCategories operation.\n\t\t\t

" + "smithy.api#documentation": "

A list of event categories for a particular source type (SourceType)\n that you want to subscribe to. You can see a list of the categories for a given source type in the \"Amazon RDS event categories and event messages\" section of the \n Amazon RDS User Guide\n or the\n \n Amazon Aurora User Guide\n .\n You can also see this list by using the DescribeEventCategories operation.

" } }, "SourceIds": { "target": "com.amazonaws.rds#SourceIdsList", "traits": { - "smithy.api#documentation": "

The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. \n An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens.

\n

Constraints:

\n " + "smithy.api#documentation": "

The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. \n An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens.

\n

Constraints:

\n " } }, "Enabled": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

\n A value that indicates whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.\n

" + "smithy.api#documentation": "

A value that indicates whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.

" } }, "Tags": { @@ -3736,7 +3736,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Creates an Aurora global database\n spread across multiple Amazon Web Services Regions. The global database\n contains a single primary cluster with read-write capability,\n and a read-only secondary cluster that receives\n data from the primary cluster through high-speed replication\n performed by the Aurora storage subsystem.\n

\n

\n You can create a global database that is initially empty, and then\n add a primary cluster and a secondary cluster to it.\n Or you can specify an existing Aurora cluster during the create operation,\n and this cluster becomes the primary cluster of the global database.\n

\n \n

This action only applies to Aurora DB clusters.

\n " + "smithy.api#documentation": "

Creates an Aurora global database\n spread across multiple Amazon Web Services Regions. The global database\n contains a single primary cluster with read-write capability,\n and a read-only secondary cluster that receives\n data from the primary cluster through high-speed replication\n performed by the Aurora storage subsystem.

\n

You can create a global database that is initially empty, and then\n add a primary cluster and a secondary cluster to it.\n Or you can specify an existing Aurora cluster during the create operation,\n and this cluster becomes the primary cluster of the global database.

\n \n

This action only applies to Aurora DB clusters.

\n " } }, "com.amazonaws.rds#CreateGlobalClusterMessage": { @@ -3751,7 +3751,7 @@ "SourceDBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) to use as the primary cluster of the global database.\n This parameter is optional.\n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) to use as the primary cluster of the global database.\n This parameter is optional.

" } }, "Engine": { @@ -3769,19 +3769,19 @@ "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

\n The deletion protection setting for the new global database.\n The global database can't be deleted when deletion protection is enabled.\n

" + "smithy.api#documentation": "

The deletion protection setting for the new global database.\n The global database can't be deleted when deletion protection is enabled.

" } }, "DatabaseName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon\n Aurora will not create a database in the global database cluster you are creating.\n

" + "smithy.api#documentation": "

The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon\n Aurora will not create a database in the global database cluster you are creating.

" } }, "StorageEncrypted": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

\n The storage encryption setting for the new global database cluster.\n

" + "smithy.api#documentation": "

The storage encryption setting for the new global database cluster.

" } } } @@ -3811,7 +3811,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new option group. You can create up to 20 option groups.

\n

This command doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

Creates a new option group. You can create up to 20 option groups.

\n

This command doesn't apply to RDS Custom.

" } }, "com.amazonaws.rds#CreateOptionGroupMessage": { @@ -3820,14 +3820,14 @@ "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the name of the option group to be created.

\n

Constraints:

\n \n

Example: myoptiongroup\n

", + "smithy.api#documentation": "

Specifies the name of the option group to be created.

\n

Constraints:

\n \n

Example: myoptiongroup\n

", "smithy.api#required": {} } }, "EngineName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the name of the engine that this option group should be associated with.

\n

Valid Values:\n

\n ", + "smithy.api#documentation": "

Specifies the name of the engine that this option group should be associated with.

\n

Valid Values:

\n ", "smithy.api#required": {} } }, @@ -4157,7 +4157,7 @@ "ReaderEndpoint": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances \n connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections \n to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. \n This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.

\n

If a failover occurs, and the Aurora Replica that you are connected to is promoted \n to be the primary instance, your connection is dropped. To \n continue sending your read workload to other Aurora Replicas in the cluster,\n you can then reconnect to the reader endpoint.

" + "smithy.api#documentation": "

The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances \n connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections \n to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. \n This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.

\n

If a failover occurs, and the Aurora Replica that you are connected to is promoted \n to be the primary instance, your connection is dropped. To \n continue sending your read workload to other Aurora Replicas in the cluster,\n you can then reconnect to the reader endpoint.

" } }, "CustomEndpoints": { @@ -4211,7 +4211,7 @@ "PreferredBackupWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the BackupRetentionPeriod.\n

" + "smithy.api#documentation": "

Specifies the daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the BackupRetentionPeriod.

" } }, "PreferredMaintenanceWindow": { @@ -4259,7 +4259,7 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" + "smithy.api#documentation": "

If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" } }, "DbClusterResourceId": { @@ -4325,7 +4325,7 @@ "Capacity": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The current capacity of an Aurora Serverless DB cluster. The capacity is 0 (zero) \n when the cluster is paused.

\n

For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the \n Amazon Aurora User Guide.

" + "smithy.api#documentation": "

The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) \n when the cluster is paused.

\n

For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the \n Amazon Aurora User Guide.

" } }, "EngineMode": { @@ -4340,19 +4340,19 @@ "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

Indicates if the DB cluster has deletion protection enabled.\n The database can't be deleted when deletion protection is enabled.\n

" + "smithy.api#documentation": "

Indicates if the DB cluster has deletion protection enabled.\n The database can't be deleted when deletion protection is enabled.

" } }, "HttpEndpointEnabled": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.

\n

When enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless DB cluster. You can also query your database\n from inside the RDS console with the query editor.

\n

For more information, see Using the Data API for Aurora Serverless in the \n Amazon Aurora User Guide.

" + "smithy.api#documentation": "

A value that indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.

\n

When enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database\n from inside the RDS console with the query editor.

\n

For more information, see Using the Data API for Aurora Serverless v1 in the \n Amazon Aurora User Guide.

" } }, "ActivityStreamMode": { "target": "com.amazonaws.rds#ActivityStreamMode", "traits": { - "smithy.api#documentation": "

The mode of the database activity stream.\n Database events such as a change or access generate an activity stream event.\n The database session can handle these events either synchronously or asynchronously.\n

" + "smithy.api#documentation": "

The mode of the database activity stream.\n Database events such as a change or access generate an activity stream event.\n The database session can handle these events either synchronously or asynchronously.

" } }, "ActivityStreamStatus": { @@ -4433,7 +4433,7 @@ "PubliclyAccessible": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

Specifies the accessibility options for the DB instance.

\n

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private \n IP address from within the DB instance's virtual private cloud (VPC). \n It resolves to the public IP address from outside of the DB instance's VPC. \n Access to the DB instance is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + "smithy.api#documentation": "

Specifies the accessibility options for the DB instance.

\n

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private \n IP address from within the DB instance's virtual private cloud (VPC). \n It resolves to the public IP address from outside of the DB instance's VPC. \n Access to the DB instance is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" } }, "AutoMinorVersionUpgrade": { @@ -4474,7 +4474,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.\n

\n

For an Amazon Aurora DB cluster, this data type is used as a response element in the operations \n CreateDBCluster, DeleteDBCluster, DescribeDBClusters, \n FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, \n RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, \n RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.

\n

For a Multi-AZ DB cluster, this data type is used as a response element in the operations \n CreateDBCluster, DeleteDBCluster, DescribeDBClusters, \n FailoverDBCluster, ModifyDBCluster, RebootDBCluster, \n RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.

\n

For an Amazon Aurora DB cluster, this data type is used as a response element in the operations \n CreateDBCluster, DeleteDBCluster, DescribeDBClusters, \n FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, \n RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, \n RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.

\n

For a Multi-AZ DB cluster, this data type is used as a response element in the operations \n CreateDBCluster, DeleteDBCluster, DescribeDBClusters, \n FailoverDBCluster, ModifyDBCluster, RebootDBCluster, \n RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" } }, "com.amazonaws.rds#DBClusterAlreadyExistsFault": { @@ -4530,7 +4530,7 @@ "Status": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The status of the backtrack. This property returns one of the following\n values:

\n " + "smithy.api#documentation": "

The status of the backtrack. This property returns one of the following\n values:

\n " } } }, @@ -4579,7 +4579,7 @@ "code": "DBClusterBacktrackNotFoundFault", "httpResponseCode": 404 }, - "smithy.api#documentation": "

\n BacktrackIdentifier doesn't refer to an existing backtrack.

", + "smithy.api#documentation": "

\n BacktrackIdentifier doesn't refer to an existing backtrack.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -4590,7 +4590,7 @@ "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

A user-supplied DB cluster identifier. This identifier is the unique key that\n identifies a DB cluster.

" + "smithy.api#documentation": "

A user-supplied DB cluster identifier. This identifier is the unique key that\n identifies a DB cluster.

" } }, "PendingCapacity": { @@ -4684,7 +4684,7 @@ } }, "traits": { - "smithy.api#documentation": "

This data type represents the information you need to connect to an Amazon Aurora DB cluster.\n This data type is used as a response element in the following actions:

\n \n

For the data structure that represents Amazon RDS DB instance endpoints,\n see Endpoint.

" + "smithy.api#documentation": "

This data type represents the information you need to connect to an Amazon Aurora DB cluster.\n This data type is used as a response element in the following actions:

\n \n

For the data structure that represents Amazon RDS DB instance endpoints,\n see Endpoint.

" } }, "com.amazonaws.rds#DBClusterEndpointAlreadyExistsFault": { @@ -4719,7 +4719,7 @@ "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterEndpoints request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterEndpoints request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" } }, "DBClusterEndpoints": { @@ -4807,7 +4807,7 @@ "PromotionTier": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

A value that specifies the order in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.\n

" + "smithy.api#documentation": "

A value that specifies the order in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

" } } }, @@ -4856,7 +4856,7 @@ "code": "DBClusterNotFoundFault", "httpResponseCode": 404 }, - "smithy.api#documentation": "

\n DBClusterIdentifier doesn't refer to an existing DB cluster.\n

", + "smithy.api#documentation": "

\n DBClusterIdentifier doesn't refer to an existing DB cluster.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -4919,7 +4919,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains the details of an Amazon RDS DB cluster parameter group.\n

\n

This data type is used as a response element in the DescribeDBClusterParameterGroups action.\n

" + "smithy.api#documentation": "

Contains the details of an Amazon RDS DB cluster parameter group.

\n

This data type is used as a response element in the DescribeDBClusterParameterGroups action.

" } }, "com.amazonaws.rds#DBClusterParameterGroupDetails": { @@ -4934,7 +4934,7 @@ "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous\n DescribeDBClusterParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" } } }, @@ -4957,7 +4957,7 @@ "DBClusterParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the DB cluster parameter group.

\n

Constraints:

\n \n \n

This value is stored as a lowercase string.

\n " + "smithy.api#documentation": "

The name of the DB cluster parameter group.

\n

Constraints:

\n \n \n

This value is stored as a lowercase string.

\n " } } }, @@ -4977,7 +4977,7 @@ "code": "DBClusterParameterGroupNotFound", "httpResponseCode": 404 }, - "smithy.api#documentation": "

\n DBClusterParameterGroupName doesn't refer to an existing DB\n cluster parameter group.

", + "smithy.api#documentation": "

\n DBClusterParameterGroupName doesn't refer to an existing DB\n cluster parameter group.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -4988,7 +4988,7 @@ "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous\n DescribeDBClusterParameterGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterParameterGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" } }, "DBClusterParameterGroups": { @@ -5031,13 +5031,13 @@ "Status": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following\n values:

\n " + "smithy.api#documentation": "

Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following\n values:

\n " } }, "FeatureName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role.\n For information about supported feature names, see DBEngineVersion.\n

" + "smithy.api#documentation": "

The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role.\n For information about supported feature names, see DBEngineVersion.

" } } }, @@ -5153,7 +5153,7 @@ "Status": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the status of this DB cluster snapshot. Valid statuses are the following:

\n " + "smithy.api#documentation": "

Specifies the status of this DB cluster snapshot. Valid statuses are the following:

\n " } }, "Port": { @@ -5213,7 +5213,7 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" + "smithy.api#documentation": "

If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" } }, "DBClusterSnapshotArn": { @@ -5239,7 +5239,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains the details for an Amazon RDS DB cluster snapshot\n

\n

This data type is used as a response element \n in the DescribeDBClusterSnapshots action.\n

" + "smithy.api#documentation": "

Contains the details for an Amazon RDS DB cluster snapshot

\n

This data type is used as a response element \n in the DescribeDBClusterSnapshots action.

" } }, "com.amazonaws.rds#DBClusterSnapshotAlreadyExistsFault": { @@ -5323,7 +5323,7 @@ "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous\n DescribeDBClusterSnapshots request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterSnapshots request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" } }, "DBClusterSnapshots": { @@ -5334,7 +5334,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n Provides a list of DB cluster snapshots for the user as the result of a call to the DescribeDBClusterSnapshots action.\n

" + "smithy.api#documentation": "

Provides a list of DB cluster snapshots for the user as the result of a call to the DescribeDBClusterSnapshots action.

" } }, "com.amazonaws.rds#DBClusterSnapshotNotFoundFault": { @@ -5349,7 +5349,7 @@ "code": "DBClusterSnapshotNotFoundFault", "httpResponseCode": 404 }, - "smithy.api#documentation": "

\n DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.\n

", + "smithy.api#documentation": "

\n DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -5390,19 +5390,19 @@ "DefaultCharacterSet": { "target": "com.amazonaws.rds#CharacterSet", "traits": { - "smithy.api#documentation": "

\n The default character set for new instances of this engine version,\n if the CharacterSetName parameter of the CreateDBInstance API\n isn't specified.\n

" + "smithy.api#documentation": "

The default character set for new instances of this engine version,\n if the CharacterSetName parameter of the CreateDBInstance API\n isn't specified.

" } }, "SupportedCharacterSets": { "target": "com.amazonaws.rds#SupportedCharacterSetsList", "traits": { - "smithy.api#documentation": "

A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation. \n

" + "smithy.api#documentation": "

A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation.

" } }, "SupportedNcharCharacterSets": { "target": "com.amazonaws.rds#SupportedCharacterSetsList", "traits": { - "smithy.api#documentation": "

A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation. \n

" + "smithy.api#documentation": "

A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.

" } }, "ValidUpgradeTarget": { @@ -5414,7 +5414,7 @@ "SupportedTimezones": { "target": "com.amazonaws.rds#SupportedTimezonesList", "traits": { - "smithy.api#documentation": "

A list of the time zones supported by this engine for the\n Timezone parameter of the CreateDBInstance action. \n

" + "smithy.api#documentation": "

A list of the time zones supported by this engine for the\n Timezone parameter of the CreateDBInstance action.

" } }, "ExportableLogTypes": { @@ -5444,7 +5444,7 @@ "SupportedFeatureNames": { "target": "com.amazonaws.rds#FeatureNameList", "traits": { - "smithy.api#documentation": "

\n A list of features supported by the DB engine.\n

\n

The supported features vary by DB engine and DB engine version.

\n

To determine the supported features for a specific DB engine and DB engine version using the CLI, \n use the following command:

\n

\n aws rds describe-db-engine-versions --engine --engine-version \n

\n

For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, \n use the following command:

\n

\n aws rds describe-db-engine-versions --engine postgres --engine-version 13.3\n

\n

The supported features are listed under SupportedFeatureNames in the output.

" + "smithy.api#documentation": "

A list of features supported by the DB engine.

\n

The supported features vary by DB engine and DB engine version.

\n

To determine the supported features for a specific DB engine and DB engine version using the CLI, \n use the following command:

\n

\n aws rds describe-db-engine-versions --engine --engine-version \n

\n

For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, \n use the following command:

\n

\n aws rds describe-db-engine-versions --engine postgres --engine-version 13.3\n

\n

The supported features are listed under SupportedFeatureNames in the output.

" } }, "Status": { @@ -5512,7 +5512,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n This data type is used as a response element in the action DescribeDBEngineVersions.\n

" + "smithy.api#documentation": "

This data type is used as a response element in the action DescribeDBEngineVersions.

" } }, "com.amazonaws.rds#DBEngineVersionList": { @@ -5530,18 +5530,18 @@ "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" } }, "DBEngineVersions": { "target": "com.amazonaws.rds#DBEngineVersionList", "traits": { - "smithy.api#documentation": "

\n A list of DBEngineVersion elements.\n

" + "smithy.api#documentation": "

A list of DBEngineVersion elements.

" } } }, "traits": { - "smithy.api#documentation": "

\n Contains the result of a successful invocation of the DescribeDBEngineVersions action.\n

" + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBEngineVersions action.

" } }, "com.amazonaws.rds#DBInstance": { @@ -5568,7 +5568,7 @@ "DBInstanceStatus": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the current state of this database.

\n

For information about DB instance statuses, see\n Viewing DB instance status \n in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

Specifies the current state of this database.

\n

For information about DB instance statuses, see\n Viewing DB instance status \n in the Amazon RDS User Guide.\n

" } }, "AutomaticRestartTime": { @@ -5586,13 +5586,13 @@ "DBName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The meaning of this parameter differs according to the database engine you use.

\n

\n MySQL, MariaDB, SQL Server, PostgreSQL\n

\n

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.

\n

Type: String

\n

\n Oracle\n

\n

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.

" + "smithy.api#documentation": "

The meaning of this parameter differs according to the database engine you use.

\n

\n MySQL, MariaDB, SQL Server, PostgreSQL\n

\n

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.

\n

Type: String

\n

\n Oracle\n

\n

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.

" } }, "Endpoint": { "target": "com.amazonaws.rds#Endpoint", "traits": { - "smithy.api#documentation": "

Specifies the connection endpoint.

\n \n

The endpoint might not be shown for instances whose status is creating.

\n " + "smithy.api#documentation": "

Specifies the connection endpoint.

\n \n

The endpoint might not be shown for instances whose status is creating.

\n " } }, "AllocatedStorage": { @@ -5610,7 +5610,7 @@ "PreferredBackupWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n Specifies the daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the BackupRetentionPeriod.\n

" + "smithy.api#documentation": "

Specifies the daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the BackupRetentionPeriod.

" } }, "BackupRetentionPeriod": { @@ -5622,7 +5622,7 @@ "DBSecurityGroups": { "target": "com.amazonaws.rds#DBSecurityGroupMembershipList", "traits": { - "smithy.api#documentation": "

\n A list of DB security group elements containing \n DBSecurityGroup.Name and DBSecurityGroup.Status subelements.\n

" + "smithy.api#documentation": "

A list of DB security group elements containing \n DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

" } }, "VpcSecurityGroups": { @@ -5736,7 +5736,7 @@ "NcharCharacterSetName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the NCHAR character set for the Oracle DB instance. This character set specifies the\n Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.\n

" + "smithy.api#documentation": "

The name of the NCHAR character set for the Oracle DB instance. This character set specifies the\n Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.

" } }, "SecondaryAvailabilityZone": { @@ -5748,7 +5748,7 @@ "PubliclyAccessible": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

Specifies the accessibility options for the DB instance.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

" + "smithy.api#documentation": "

Specifies the accessibility options for the DB instance.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

" } }, "StatusInfos": { @@ -5790,7 +5790,7 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n If StorageEncrypted is true, the Amazon Web Services KMS key identifier \n for the encrypted DB instance.\n

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" + "smithy.api#documentation": "

If StorageEncrypted is true, the Amazon Web Services KMS key identifier \n for the encrypted DB instance.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" } }, "DbiResourceId": { @@ -5814,7 +5814,7 @@ "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

\n

\n Amazon Aurora\n

\n

Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting. For more\n information, see DBCluster.

" + "smithy.api#documentation": "

Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

\n

\n Amazon Aurora\n

\n

Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting. For more\n information, see DBCluster.

" } }, "MonitoringInterval": { @@ -5838,7 +5838,7 @@ "PromotionTier": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

A value that specifies the order in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.\n

" + "smithy.api#documentation": "

A value that specifies the order in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

" } }, "DBInstanceArn": { @@ -5850,13 +5850,13 @@ "Timezone": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The time zone of the DB instance.\n In most cases, the Timezone element is empty.\n Timezone content appears only for\n Microsoft SQL Server DB instances \n that were created with a time zone specified.\n

" + "smithy.api#documentation": "

The time zone of the DB instance.\n In most cases, the Timezone element is empty.\n Timezone content appears only for\n Microsoft SQL Server DB instances \n that were created with a time zone specified.

" } }, "IAMDatabaseAuthenticationEnabled": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

\n\n

IAM database authentication can be enabled for the following database engines

\n " + "smithy.api#documentation": "

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

\n

IAM database authentication can be enabled for the following database engines

\n " } }, "PerformanceInsightsEnabled": { @@ -5874,7 +5874,7 @@ "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

" + "smithy.api#documentation": "

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

" } }, "EnabledCloudwatchLogsExports": { @@ -5892,13 +5892,13 @@ "DeletionProtection": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

Indicates if the DB instance has deletion protection enabled.\n The database can't be deleted when deletion protection is enabled.\n For more information, see \n \n Deleting a DB Instance.\n

" + "smithy.api#documentation": "

Indicates if the DB instance has deletion protection enabled.\n The database can't be deleted when deletion protection is enabled.\n For more information, see \n \n Deleting a DB Instance.

" } }, "AssociatedRoles": { "target": "com.amazonaws.rds#DBInstanceRoles", "traits": { - "smithy.api#documentation": "

\n The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.\n

" + "smithy.api#documentation": "

The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.

" } }, "ListenerEndpoint": { @@ -5973,13 +5973,13 @@ "ResumeFullAutomationModeTime": { "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. \n The minimum value is 60 (default). The maximum value is 1,440.\n

" + "smithy.api#documentation": "

The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. \n The minimum value is 60 (default). The maximum value is 1,440.

" } }, "CustomIamInstanceProfile": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n \n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon Relational Database Service\n User Guide.

" + "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n \n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

" } }, "BackupTarget": { @@ -5990,7 +5990,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains the details of an Amazon RDS DB instance.\n

\n

This data type is used as a response element in the operations CreateDBInstance, \n CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, \n ModifyDBInstance, PromoteReadReplica, RebootDBInstance, \n RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, RestoreDBInstanceToPointInTime, \n StartDBInstance, and StopDBInstance.\n

" + "smithy.api#documentation": "

Contains the details of an Amazon RDS DB instance.

\n

This data type is used as a response element in the operations CreateDBInstance, \n CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, \n ModifyDBInstance, PromoteReadReplica, RebootDBInstance, \n RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, RestoreDBInstanceToPointInTime, \n StartDBInstance, and StopDBInstance.

" } }, "com.amazonaws.rds#DBInstanceAlreadyExistsFault": { @@ -6034,7 +6034,7 @@ "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The customer id of the instance that is/was associated with the automated backup.\n

" + "smithy.api#documentation": "

The customer id of the instance that is/was associated with the automated backup.

" } }, "RestoreWindow": { @@ -6052,7 +6052,7 @@ "Status": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Provides a list of status information for an automated backup:

\n " + "smithy.api#documentation": "

Provides a list of status information for an automated backup:

\n " } }, "Port": { @@ -6076,7 +6076,7 @@ "InstanceCreateTime": { "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

Provides the date and time that the DB instance was created.\n

" + "smithy.api#documentation": "

Provides the date and time that the DB instance was created.

" } }, "MasterUsername": { @@ -6106,7 +6106,7 @@ "Iops": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The IOPS (I/O operations per second) value for the automated backup.

" + "smithy.api#documentation": "

The IOPS (I/O operations per second) value for the automated backup.

" } }, "OptionGroupName": { @@ -6136,7 +6136,7 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key ID for an automated backup.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" + "smithy.api#documentation": "

The Amazon Web Services KMS key ID for an automated backup.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" } }, "Timezone": { @@ -6195,18 +6195,18 @@ "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" } }, "DBInstanceAutomatedBackups": { "target": "com.amazonaws.rds#DBInstanceAutomatedBackupList", "traits": { - "smithy.api#documentation": "

\n A list of DBInstanceAutomatedBackup instances.\n

" + "smithy.api#documentation": "

A list of DBInstanceAutomatedBackup instances.

" } } }, "traits": { - "smithy.api#documentation": "

\n Contains the result of a successful invocation of the DescribeDBInstanceAutomatedBackups action.\n

" + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBInstanceAutomatedBackups action.

" } }, "com.amazonaws.rds#DBInstanceAutomatedBackupNotFoundFault": { @@ -6281,18 +6281,18 @@ "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .

" } }, "DBInstances": { "target": "com.amazonaws.rds#DBInstanceList", "traits": { - "smithy.api#documentation": "

\n A list of DBInstance instances.\n

" + "smithy.api#documentation": "

A list of DBInstance instances.

" } } }, "traits": { - "smithy.api#documentation": "

\n Contains the result of a successful invocation of the DescribeDBInstances action.\n

" + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBInstances action.

" } }, "com.amazonaws.rds#DBInstanceNotFoundFault": { @@ -6307,7 +6307,7 @@ "code": "DBInstanceNotFound", "httpResponseCode": 404 }, - "smithy.api#documentation": "

\n DBInstanceIdentifier doesn't refer to an existing DB instance.\n

", + "smithy.api#documentation": "

\n DBInstanceIdentifier doesn't refer to an existing DB instance.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -6324,13 +6324,13 @@ "FeatureName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role.\n For information about supported feature names, see DBEngineVersion.\n

" + "smithy.api#documentation": "

The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role.\n For information about supported feature names, see DBEngineVersion.

" } }, "Status": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following\n values:

\n " + "smithy.api#documentation": "

Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following\n values:

\n " } } }, @@ -6485,7 +6485,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains the details of an Amazon RDS DB parameter group.\n

\n

This data type is used as a response element in the DescribeDBParameterGroups action.\n

" + "smithy.api#documentation": "

Contains the details of an Amazon RDS DB parameter group.

\n

This data type is used as a response element in the DescribeDBParameterGroups action.

" } }, "com.amazonaws.rds#DBParameterGroupAlreadyExistsFault": { @@ -6511,18 +6511,18 @@ "Parameters": { "target": "com.amazonaws.rds#ParametersList", "traits": { - "smithy.api#documentation": "

\n A list of Parameter values.\n

" + "smithy.api#documentation": "

A list of Parameter values.

" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" } } }, "traits": { - "smithy.api#documentation": "

\n Contains the result of a successful invocation of the DescribeDBParameters action.\n

" + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBParameters action.

" } }, "com.amazonaws.rds#DBParameterGroupList": { @@ -6545,7 +6545,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n Contains the result of a successful invocation of the \n ModifyDBParameterGroup or ResetDBParameterGroup action.\n

" + "smithy.api#documentation": "

Contains the result of a successful invocation of the \n ModifyDBParameterGroup or ResetDBParameterGroup action.

" } }, "com.amazonaws.rds#DBParameterGroupNotFoundFault": { @@ -6560,7 +6560,7 @@ "code": "DBParameterGroupNotFound", "httpResponseCode": 404 }, - "smithy.api#documentation": "

\n DBParameterGroupName doesn't refer to an\n existing DB parameter group.\n

", + "smithy.api#documentation": "

\n DBParameterGroupName doesn't refer to an\n existing DB parameter group.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -6599,7 +6599,7 @@ } }, "traits": { - "smithy.api#documentation": "

The status of the DB parameter group.

\n

This data type is used as a response element in the following actions:

\n " + "smithy.api#documentation": "

The status of the DB parameter group.

\n

This data type is used as a response element in the following actions:

\n " } }, "com.amazonaws.rds#DBParameterGroupStatusList": { @@ -6617,18 +6617,18 @@ "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" } }, "DBParameterGroups": { "target": "com.amazonaws.rds#DBParameterGroupList", "traits": { - "smithy.api#documentation": "

\n A list of DBParameterGroup instances.\n

" + "smithy.api#documentation": "

A list of DBParameterGroup instances.

" } } }, "traits": { - "smithy.api#documentation": "

\n Contains the result of a successful invocation of the DescribeDBParameterGroups action.\n

" + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBParameterGroups action.

" } }, "com.amazonaws.rds#DBProxy": { @@ -6703,7 +6703,7 @@ "IdleClientTimeout": { "target": "com.amazonaws.rds#Integer", "traits": { - "smithy.api#documentation": "

The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection.\n The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by\n later connection requests.

\n

Default: 1800 (30 minutes)

\n

Constraints: 1 to 28,800

" + "smithy.api#documentation": "

The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection.\n The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by\n later connection requests.

\n

Default: 1800 (30 minutes)

\n

Constraints: 1 to 28,800

" } }, "DebugLogging": { @@ -6726,7 +6726,7 @@ } }, "traits": { - "smithy.api#documentation": "

The data structure representing a proxy managed by the RDS Proxy.

\n

This data type is used as a response element in the DescribeDBProxies action.

" + "smithy.api#documentation": "

The data structure representing a proxy managed by the RDS Proxy.

\n

This data type is used as a response element in the DescribeDBProxies action.

" } }, "com.amazonaws.rds#DBProxyAlreadyExistsFault": { @@ -6817,7 +6817,7 @@ } }, "traits": { - "smithy.api#documentation": "

The data structure representing an endpoint associated with a DB proxy. RDS automatically creates one\n endpoint for each DB proxy. For Aurora DB clusters, you can associate additional endpoints with the same\n DB proxy. These endpoints can be read/write or read-only. They can also reside in different VPCs than the\n associated DB proxy.

\n

This data type is used as a response element in the DescribeDBProxyEndpoints operation.

" + "smithy.api#documentation": "

The data structure representing an endpoint associated with a DB proxy. RDS automatically creates one\n endpoint for each DB proxy. For Aurora DB clusters, you can associate additional endpoints with the same\n DB proxy. These endpoints can be read/write or read-only. They can also reside in different VPCs than the\n associated DB proxy.

\n

This data type is used as a response element in the DescribeDBProxyEndpoints operation.

" } }, "com.amazonaws.rds#DBProxyEndpointAlreadyExistsFault": { @@ -7079,7 +7079,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains the details for an RDS Proxy target. It represents an RDS DB instance or Aurora DB cluster\n that the proxy can connect to. One or more targets are associated with an RDS Proxy target group.

\n

This data type is used as a response element in the DescribeDBProxyTargets action.

" + "smithy.api#documentation": "

Contains the details for an RDS Proxy target. It represents an RDS DB instance or Aurora DB cluster\n that the proxy can connect to. One or more targets are associated with an RDS Proxy target group.

\n

This data type is used as a response element in the DescribeDBProxyTargets action.

" } }, "com.amazonaws.rds#DBProxyTargetAlreadyRegisteredFault": { @@ -7152,7 +7152,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents a set of RDS DB instances, Aurora DB clusters, or both that a proxy can connect to. Currently, each target group\n is associated with exactly one RDS DB instance or Aurora DB cluster.

\n

This data type is used as a response element in the DescribeDBProxyTargetGroups action.

" + "smithy.api#documentation": "

Represents a set of RDS DB instances, Aurora DB clusters, or both that a proxy can connect to. Currently, each target group\n is associated with exactly one RDS DB instance or Aurora DB cluster.

\n

This data type is used as a response element in the DescribeDBProxyTargetGroups action.

" } }, "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault": { @@ -7219,13 +7219,13 @@ "EC2SecurityGroups": { "target": "com.amazonaws.rds#EC2SecurityGroupList", "traits": { - "smithy.api#documentation": "

\n Contains a list of EC2SecurityGroup elements.\n

" + "smithy.api#documentation": "

Contains a list of EC2SecurityGroup elements.

" } }, "IPRanges": { "target": "com.amazonaws.rds#IPRangeList", "traits": { - "smithy.api#documentation": "

\n Contains a list of IPRange elements.\n

" + "smithy.api#documentation": "

Contains a list of IPRange elements.

" } }, "DBSecurityGroupArn": { @@ -7236,7 +7236,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains the details for an Amazon RDS DB security group.\n

\n

This data type is used as a response element \n in the DescribeDBSecurityGroups action.\n

" + "smithy.api#documentation": "

Contains the details for an Amazon RDS DB security group.

\n

This data type is used as a response element \n in the DescribeDBSecurityGroups action.

" } }, "com.amazonaws.rds#DBSecurityGroupAlreadyExistsFault": { @@ -7251,7 +7251,7 @@ "code": "DBSecurityGroupAlreadyExists", "httpResponseCode": 400 }, - "smithy.api#documentation": "

\n A DB security group with the name specified in\n DBSecurityGroupName already exists.\n

", + "smithy.api#documentation": "

A DB security group with the name specified in\n DBSecurityGroupName already exists.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -7273,7 +7273,7 @@ } }, "traits": { - "smithy.api#documentation": "

This data type is used as a response element in the following actions:

\n " + "smithy.api#documentation": "

This data type is used as a response element in the following actions:

\n " } }, "com.amazonaws.rds#DBSecurityGroupMembershipList": { @@ -7291,18 +7291,18 @@ "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" } }, "DBSecurityGroups": { "target": "com.amazonaws.rds#DBSecurityGroups", "traits": { - "smithy.api#documentation": "

\n A list of DBSecurityGroup instances.\n

" + "smithy.api#documentation": "

A list of DBSecurityGroup instances.

" } } }, "traits": { - "smithy.api#documentation": "

\n Contains the result of a successful invocation of the DescribeDBSecurityGroups action.\n

" + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBSecurityGroups action.

" } }, "com.amazonaws.rds#DBSecurityGroupNameList": { @@ -7326,7 +7326,7 @@ "code": "DBSecurityGroupNotFound", "httpResponseCode": 404 }, - "smithy.api#documentation": "

\n DBSecurityGroupName doesn't refer to an existing DB security group.\n

", + "smithy.api#documentation": "

\n DBSecurityGroupName doesn't refer to an existing DB security group.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -7512,7 +7512,7 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n If Encrypted is true, the Amazon Web Services KMS key identifier \n for the encrypted DB snapshot.\n

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" + "smithy.api#documentation": "

If Encrypted is true, the Amazon Web Services KMS key identifier \n for the encrypted DB snapshot.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" } }, "DBSnapshotArn": { @@ -7524,7 +7524,7 @@ "Timezone": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The time zone of the DB snapshot.\n In most cases, the Timezone element is empty.\n Timezone content appears only for\n snapshots taken from \n Microsoft SQL Server DB instances \n that were created with a time zone specified.\n

" + "smithy.api#documentation": "

The time zone of the DB snapshot.\n In most cases, the Timezone element is empty.\n Timezone content appears only for\n snapshots taken from \n Microsoft SQL Server DB instances \n that were created with a time zone specified.

" } }, "IAMDatabaseAuthenticationEnabled": { @@ -7562,7 +7562,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains the details of an Amazon RDS DB snapshot.\n

\n

This data type is used as a response element \n in the DescribeDBSnapshots action.\n

" + "smithy.api#documentation": "

Contains the details of an Amazon RDS DB snapshot.

\n

This data type is used as a response element \n in the DescribeDBSnapshots action.

" } }, "com.amazonaws.rds#DBSnapshotAlreadyExistsFault": { @@ -7577,7 +7577,7 @@ "code": "DBSnapshotAlreadyExists", "httpResponseCode": 400 }, - "smithy.api#documentation": "

\n DBSnapshotIdentifier is already used by an existing snapshot.\n

", + "smithy.api#documentation": "

\n DBSnapshotIdentifier is already used by an existing snapshot.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -7588,18 +7588,18 @@ "AttributeName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the manual DB snapshot attribute.

\n

The attribute named restore refers to the list of Amazon Web Services accounts that\n have permission to copy or restore the manual DB cluster snapshot. For more information, \n see the ModifyDBSnapshotAttribute\n API action.

" + "smithy.api#documentation": "

The name of the manual DB snapshot attribute.

\n

The attribute named restore refers to the list of Amazon Web Services accounts that\n have permission to copy or restore the manual DB cluster snapshot. For more information, \n see the ModifyDBSnapshotAttribute\n API action.

" } }, "AttributeValues": { "target": "com.amazonaws.rds#AttributeValueList", "traits": { - "smithy.api#documentation": "

The value or values for the manual DB snapshot attribute.

\n

If the AttributeName field is set to restore, then this element\n returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual\n DB snapshot. If a value of all is in the list, then the manual DB snapshot\n is public and available for any Amazon Web Services account to copy or restore.

" + "smithy.api#documentation": "

The value or values for the manual DB snapshot attribute.

\n

If the AttributeName field is set to restore, then this element\n returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual\n DB snapshot. If a value of all is in the list, then the manual DB snapshot\n is public and available for any Amazon Web Services account to copy or restore.

" } } }, "traits": { - "smithy.api#documentation": "

Contains the name and values of a manual DB snapshot attribute

\n

Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts\n to restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute\n API.

" + "smithy.api#documentation": "

Contains the name and values of a manual DB snapshot attribute

\n

Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts\n to restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute\n API.

" } }, "com.amazonaws.rds#DBSnapshotAttributeList": { @@ -7628,7 +7628,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains the results of a successful call to the DescribeDBSnapshotAttributes\n API action.

\n

Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts\n to copy or restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute\n API action.

" + "smithy.api#documentation": "

Contains the results of a successful call to the DescribeDBSnapshotAttributes\n API action.

\n

Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts\n to copy or restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute\n API action.

" } }, "com.amazonaws.rds#DBSnapshotList": { @@ -7646,18 +7646,18 @@ "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" } }, "DBSnapshots": { "target": "com.amazonaws.rds#DBSnapshotList", "traits": { - "smithy.api#documentation": "

\n A list of DBSnapshot instances.\n

" + "smithy.api#documentation": "

A list of DBSnapshot instances.

" } } }, "traits": { - "smithy.api#documentation": "

\n Contains the result of a successful invocation of the DescribeDBSnapshots action.\n

" + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBSnapshots action.

" } }, "com.amazonaws.rds#DBSnapshotNotFoundFault": { @@ -7672,7 +7672,7 @@ "code": "DBSnapshotNotFound", "httpResponseCode": 404 }, - "smithy.api#documentation": "

\n DBSnapshotIdentifier doesn't refer to an existing DB snapshot.\n

", + "smithy.api#documentation": "

\n DBSnapshotIdentifier doesn't refer to an existing DB snapshot.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -7707,7 +7707,7 @@ "Subnets": { "target": "com.amazonaws.rds#SubnetList", "traits": { - "smithy.api#documentation": "

\n Contains a list of Subnet elements.\n

" + "smithy.api#documentation": "

Contains a list of Subnet elements.

" } }, "DBSubnetGroupArn": { @@ -7718,7 +7718,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains the details of an Amazon RDS DB subnet group.\n

\n

This data type is used as a response element \n in the DescribeDBSubnetGroups action.\n

" + "smithy.api#documentation": "

Contains the details of an Amazon RDS DB subnet group.

\n

This data type is used as a response element \n in the DescribeDBSubnetGroups action.

" } }, "com.amazonaws.rds#DBSubnetGroupAlreadyExistsFault": { @@ -7733,7 +7733,7 @@ "code": "DBSubnetGroupAlreadyExists", "httpResponseCode": 400 }, - "smithy.api#documentation": "

\n DBSubnetGroupName is already used by an existing DB subnet group.\n

", + "smithy.api#documentation": "

\n DBSubnetGroupName is already used by an existing DB subnet group.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -7761,18 +7761,18 @@ "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" } }, "DBSubnetGroups": { "target": "com.amazonaws.rds#DBSubnetGroups", "traits": { - "smithy.api#documentation": "

\n A list of DBSubnetGroup instances.\n

" + "smithy.api#documentation": "

A list of DBSubnetGroup instances.

" } } }, "traits": { - "smithy.api#documentation": "

\n Contains the result of a successful invocation of the DescribeDBSubnetGroups action.\n

" + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBSubnetGroups action.

" } }, "com.amazonaws.rds#DBSubnetGroupNotAllowedFault": { @@ -7804,7 +7804,7 @@ "code": "DBSubnetGroupNotFoundFault", "httpResponseCode": 404 }, - "smithy.api#documentation": "

\n DBSubnetGroupName doesn't refer to an existing DB subnet group.\n

", + "smithy.api#documentation": "

\n DBSubnetGroupName doesn't refer to an existing DB subnet group.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -7926,7 +7926,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a custom engine version. To run this command, make sure you meet the following prerequisites:

\n \n

Typically, deletion takes a few minutes.

\n \n

The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with \n Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the \n DeleteCustomDbEngineVersion event aren't logged. However, you might see calls from the \n API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for \n the DeleteCustomDbEngineVersion event.

\n \n

For more information, see \n Deleting a CEV in the Amazon RDS User Guide.

" + "smithy.api#documentation": "

Deletes a custom engine version. To run this command, make sure you meet the following prerequisites:

\n \n

Typically, deletion takes a few minutes.

\n \n

The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with \n Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the \n DeleteCustomDbEngineVersion event aren't logged. However, you might see calls from the \n API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for \n the DeleteCustomDbEngineVersion event.

\n \n

For more information, see \n Deleting a CEV in the Amazon RDS User Guide.

" } }, "com.amazonaws.rds#DeleteCustomDBEngineVersionMessage": { @@ -7974,7 +7974,7 @@ } ], "traits": { - "smithy.api#documentation": "

The DeleteDBCluster action deletes a previously provisioned DB cluster. \n When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. \n Manual DB cluster snapshots of the specified DB cluster are not deleted.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

The DeleteDBCluster action deletes a previously provisioned DB cluster. \n When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. \n Manual DB cluster snapshots of the specified DB cluster are not deleted.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

" } }, "com.amazonaws.rds#DeleteDBClusterEndpoint": { @@ -7997,7 +7997,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.

\n \n

This action only applies to Aurora DB clusters.

\n " + "smithy.api#documentation": "

Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.

\n \n

This action only applies to Aurora DB clusters.

\n " } }, "com.amazonaws.rds#DeleteDBClusterEndpointMessage": { @@ -8018,20 +8018,20 @@ "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive.

\n

Constraints:

\n ", + "smithy.api#documentation": "

The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive.

\n

Constraints:

\n ", "smithy.api#required": {} } }, "SkipFinalSnapshot": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

A value that indicates whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted.\n If skip is specified, no DB cluster snapshot is created. If skip isn't specified, a DB cluster snapshot \n is created before the DB cluster is deleted. By default, skip isn't specified, and the DB cluster snapshot is created. \n By default, this parameter is disabled.

\n \n

You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.

\n " + "smithy.api#documentation": "

A value that indicates whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted.\n If skip is specified, no DB cluster snapshot is created. If skip isn't specified, a DB cluster snapshot \n is created before the DB cluster is deleted. By default, skip isn't specified, and the DB cluster snapshot is created. \n By default, this parameter is disabled.

\n \n

You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.

\n " } }, "FinalDBSnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot\n is disabled.\n

\n \n

\n Specifying this parameter and also skipping the creation of a final DB cluster snapshot \n with the SkipFinalShapshot parameter results in an error.

\n \n

Constraints:

\n " + "smithy.api#documentation": "

The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot\n is disabled.

\n \n

Specifying this parameter and also skipping the creation of a final DB cluster snapshot \n with the SkipFinalShapshot parameter results in an error.

\n \n

Constraints:

\n " } } }, @@ -8053,7 +8053,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

" } }, "com.amazonaws.rds#DeleteDBClusterParameterGroupMessage": { @@ -8062,7 +8062,7 @@ "DBClusterParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the DB cluster parameter group.

\n

Constraints:

\n ", + "smithy.api#documentation": "

The name of the DB cluster parameter group.

\n

Constraints:

\n ", "smithy.api#required": {} } } @@ -8096,7 +8096,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.

\n \n

The DB cluster snapshot must be in the available state to be\n deleted.

\n \n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.

\n \n

The DB cluster snapshot must be in the available state to be\n deleted.

\n \n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

" } }, "com.amazonaws.rds#DeleteDBClusterSnapshotMessage": { @@ -8105,7 +8105,7 @@ "DBClusterSnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The identifier of the DB cluster snapshot to delete.

\n

Constraints: Must be the name of an existing DB cluster snapshot in the available state.

", + "smithy.api#documentation": "

The identifier of the DB cluster snapshot to delete.

\n

Constraints: Must be the name of an existing DB cluster snapshot in the available state.

", "smithy.api#required": {} } } @@ -8151,7 +8151,7 @@ } ], "traits": { - "smithy.api#documentation": "

The DeleteDBInstance action deletes a previously provisioned DB instance. \n When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. \n Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.

\n

\n If you request a final DB snapshot \n the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance\n is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.\n

\n

When a DB instance is in a failure state and has a status of failed, incompatible-restore, \n or incompatible-network, you can only delete it when you skip creation of the final snapshot with the SkipFinalSnapshot parameter.

\n\n

If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following\n conditions are true:

\n \n

To delete a DB instance in this case, first call the\n PromoteReadReplicaDBCluster API action to promote the DB cluster so\n it's no longer a read replica. After the promotion completes, then call the\n DeleteDBInstance API action to delete the final instance in the DB\n cluster.

" + "smithy.api#documentation": "

The DeleteDBInstance action deletes a previously provisioned DB instance. \n When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. \n Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.

\n

If you request a final DB snapshot \n the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance\n is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.

\n

When a DB instance is in a failure state and has a status of failed, incompatible-restore, \n or incompatible-network, you can only delete it when you skip creation of the final snapshot with the SkipFinalSnapshot parameter.

\n

If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following\n conditions are true:

\n \n

To delete a DB instance in this case, first call the\n PromoteReadReplicaDBCluster API action to promote the DB cluster so\n it's no longer a read replica. After the promotion completes, then call the\n DeleteDBInstance API action to delete the final instance in the DB\n cluster.

" } }, "com.amazonaws.rds#DeleteDBInstanceAutomatedBackup": { @@ -8208,20 +8208,20 @@ "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.

\n

Constraints:

\n ", + "smithy.api#documentation": "

The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.

\n

Constraints:

\n ", "smithy.api#required": {} } }, "SkipFinalSnapshot": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

A value that indicates whether to skip the creation of a final DB snapshot before deleting the instance.\n If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, \n RDS creates a DB snapshot before the DB instance is deleted. By default, skip isn't enabled, \n and the DB snapshot is created.

\n \n

If you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier parameter.

\n \n

When a DB instance is in a failure state and has a status of failed, incompatible-restore, \n or incompatible-network, RDS can delete the instance only if you enable this parameter.

\n

If you delete a read replica or an RDS Custom instance, you must enable this setting.

\n

This setting is required for RDS Custom.

" + "smithy.api#documentation": "

A value that indicates whether to skip the creation of a final DB snapshot before deleting the instance.\n If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, \n RDS creates a DB snapshot before the DB instance is deleted. By default, skip isn't enabled, \n and the DB snapshot is created.

\n \n

If you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier parameter.

\n \n

When a DB instance is in a failure state and has a status of failed, incompatible-restore, \n or incompatible-network, RDS can delete the instance only if you enable this parameter.

\n

If you delete a read replica or an RDS Custom instance, you must enable this setting.

\n

This setting is required for RDS Custom.

" } }, "FinalDBSnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot\n parameter is disabled.\n

\n \n

If you enable this parameter and also enable SkipFinalShapshot, the command results in an error.

\n \n

This setting doesn't apply to RDS Custom.

\n

Constraints:

\n " + "smithy.api#documentation": "

The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot\n parameter is disabled.

\n \n

If you enable this parameter and also enable SkipFinalShapshot, the command results in an error.

\n \n

This setting doesn't apply to RDS Custom.

\n

Constraints:

\n " } }, "DeleteAutomatedBackups": { @@ -8266,7 +8266,7 @@ "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the DB parameter group.

\n

Constraints:

\n ", + "smithy.api#documentation": "

The name of the DB parameter group.

\n

Constraints:

\n ", "smithy.api#required": {} } } @@ -8375,7 +8375,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a DB security group.

\n \n

The specified DB security group must not be associated with any DB instances.

\n " + "smithy.api#documentation": "

Deletes a DB security group.

\n \n

The specified DB security group must not be associated with any DB instances.

\n " } }, "com.amazonaws.rds#DeleteDBSecurityGroupMessage": { @@ -8384,7 +8384,7 @@ "DBSecurityGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the DB security group to delete.

\n \n

You can't delete the default DB security group.

\n \n

Constraints:

\n ", + "smithy.api#documentation": "

The name of the DB security group to delete.

\n \n

You can't delete the default DB security group.

\n \n

Constraints:

\n ", "smithy.api#required": {} } } @@ -8410,7 +8410,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a DB snapshot. If the snapshot is being copied, the copy operation is\n terminated.

\n \n

The DB snapshot must be in the available state to be deleted.

\n " + "smithy.api#documentation": "

Deletes a DB snapshot. If the snapshot is being copied, the copy operation is\n terminated.

\n \n

The DB snapshot must be in the available state to be deleted.

\n " } }, "com.amazonaws.rds#DeleteDBSnapshotMessage": { @@ -8419,7 +8419,7 @@ "DBSnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The DB snapshot identifier.

\n

Constraints: Must be the name of an existing DB snapshot in the available state.

", + "smithy.api#documentation": "

The DB snapshot identifier.

\n

Constraints: Must be the name of an existing DB snapshot in the available state.

", "smithy.api#required": {} } } @@ -8453,7 +8453,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a DB subnet group.

\n \n

The specified database subnet group must not be associated with any DB instances.

\n " + "smithy.api#documentation": "

Deletes a DB subnet group.

\n \n

The specified database subnet group must not be associated with any DB instances.

\n " } }, "com.amazonaws.rds#DeleteDBSubnetGroupMessage": { @@ -8462,7 +8462,7 @@ "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the database subnet group to delete.

\n \n

You can't delete the default subnet group.

\n \n

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

\n

Example: mydbsubnetgroup\n

", + "smithy.api#documentation": "

The name of the database subnet group to delete.

\n \n

You can't delete the default subnet group.

\n \n

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

\n

Example: mydbsubnetgroup\n

", "smithy.api#required": {} } } @@ -8531,7 +8531,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Deletes a global database cluster. The primary and secondary clusters must already be detached or\n destroyed first.\n

\n \n

This action only applies to Aurora DB clusters.

\n " + "smithy.api#documentation": "

Deletes a global database cluster. The primary and secondary clusters must already be detached or\n destroyed first.

\n \n

This action only applies to Aurora DB clusters.

\n " } }, "com.amazonaws.rds#DeleteGlobalClusterMessage": { @@ -8540,7 +8540,7 @@ "GlobalClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n The cluster identifier of the global database cluster being deleted.\n

", + "smithy.api#documentation": "

The cluster identifier of the global database cluster being deleted.

", "smithy.api#required": {} } } @@ -8606,7 +8606,7 @@ "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the option group to be deleted.

\n \n

You can't delete default option groups.

\n ", + "smithy.api#documentation": "

The name of the option group to be deleted.

\n \n

You can't delete default option groups.

\n ", "smithy.api#required": {} } } @@ -8684,7 +8684,7 @@ "target": "com.amazonaws.rds#AccountAttributesMessage" }, "traits": { - "smithy.api#documentation": "

Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.

\n

This command doesn't take any parameters.

" + "smithy.api#documentation": "

Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.

\n

This command doesn't take any parameters.

" } }, "com.amazonaws.rds#DescribeAccountAttributesMessage": { @@ -8723,7 +8723,7 @@ "CertificateIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The user-supplied certificate identifier. If this parameter is specified, information for only the identified certificate is returned. This parameter isn't case-sensitive.

\n

Constraints:

\n " + "smithy.api#documentation": "

The user-supplied certificate identifier. If this parameter is specified, information for only the identified certificate is returned. This parameter isn't case-sensitive.

\n

Constraints:

\n " } }, "Filters": { @@ -8735,13 +8735,13 @@ "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.\n

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous\n DescribeCertificates request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeCertificates request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" } } }, @@ -8818,7 +8818,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about backtracks for a DB cluster.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n

\n \n

This action only applies to Aurora MySQL DB clusters.

\n ", + "smithy.api#documentation": "

Returns information about backtracks for a DB cluster.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n \n

This action only applies to Aurora MySQL DB clusters.

\n ", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -8833,32 +8833,32 @@ "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The DB cluster identifier of the DB cluster to be described. This parameter is\n stored as a lowercase string.

\n

Constraints:

\n \n

Example: my-cluster1\n

", + "smithy.api#documentation": "

The DB cluster identifier of the DB cluster to be described. This parameter is\n stored as a lowercase string.

\n

Constraints:

\n \n

Example: my-cluster1\n

", "smithy.api#required": {} } }, "BacktrackIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

If specified, this value is the backtrack identifier of the backtrack to be\n described.

\n

Constraints:

\n \n

Example: 123e4567-e89b-12d3-a456-426655440000\n

" + "smithy.api#documentation": "

If specified, this value is the backtrack identifier of the backtrack to be\n described.

\n

Constraints:

\n \n

Example: 123e4567-e89b-12d3-a456-426655440000\n

" } }, "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { - "smithy.api#documentation": "

A filter that specifies one or more DB clusters to describe. Supported filters\n include the following:

\n " + "smithy.api#documentation": "

A filter that specifies one or more DB clusters to describe. Supported filters\n include the following:

\n " } }, "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.\n

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterBacktracks request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterBacktracks request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" } } }, @@ -8880,7 +8880,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about endpoints for an Amazon Aurora DB cluster.

\n \n

This action only applies to Aurora DB clusters.

\n ", + "smithy.api#documentation": "

Returns information about endpoints for an Amazon Aurora DB cluster.

\n \n

This action only applies to Aurora DB clusters.

\n ", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -8907,19 +8907,19 @@ "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { - "smithy.api#documentation": "

A set of name-value pairs that define which endpoints to include in the output.\n The filters are specified as name-value pairs, in the format\n Name=endpoint_type,Values=endpoint_type1,endpoint_type2,....\n Name can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type, db-cluster-endpoint-id, db-cluster-endpoint-status.\n Values for the db-cluster-endpoint-type filter can be one or more of: reader, writer, custom.\n Values for the db-cluster-endpoint-custom-type filter can be one or more of: reader, any.\n Values for the db-cluster-endpoint-status filter can be one or more of: available, creating, deleting, inactive, modifying.\n

" + "smithy.api#documentation": "

A set of name-value pairs that define which endpoints to include in the output.\n The filters are specified as name-value pairs, in the format\n Name=endpoint_type,Values=endpoint_type1,endpoint_type2,....\n Name can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type, db-cluster-endpoint-id, db-cluster-endpoint-status.\n Values for the db-cluster-endpoint-type filter can be one or more of: reader, writer, custom.\n Values for the db-cluster-endpoint-custom-type filter can be one or more of: reader, any.\n Values for the db-cluster-endpoint-status filter can be one or more of: available, creating, deleting, inactive, modifying.

" } }, "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.\n

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterEndpoints request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterEndpoints request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" } } } @@ -8938,7 +8938,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Returns a list of DBClusterParameterGroup descriptions. If a \n DBClusterParameterGroupName parameter is specified,\n the list will contain only the description of the specified DB cluster parameter group.\n

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

", + "smithy.api#documentation": "

Returns a list of DBClusterParameterGroup descriptions. If a \n DBClusterParameterGroupName parameter is specified,\n the list will contain only the description of the specified DB cluster parameter group.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -8953,7 +8953,7 @@ "DBClusterParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of a specific DB cluster parameter group to return details for.

\n

Constraints:

\n " + "smithy.api#documentation": "

The name of a specific DB cluster parameter group to return details for.

\n

Constraints:

\n " } }, "Filters": { @@ -8965,13 +8965,13 @@ "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.\n

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous\n DescribeDBClusterParameterGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterParameterGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" } } }, @@ -8993,7 +8993,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the detailed parameter list for a particular DB cluster parameter group.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

", + "smithy.api#documentation": "

Returns the detailed parameter list for a particular DB cluster parameter group.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -9008,14 +9008,14 @@ "DBClusterParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of a specific DB cluster parameter group to return parameter details for.

\n

Constraints:

\n ", + "smithy.api#documentation": "

The name of a specific DB cluster parameter group to return parameter details for.

\n

Constraints:

\n ", "smithy.api#required": {} } }, "Source": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n A value that indicates to return only parameters for a specific source. \n Parameter sources can be engine, service,\n or customer.\n

" + "smithy.api#documentation": "

A value that indicates to return only parameters for a specific source. \n Parameter sources can be engine, service,\n or customer.

" } }, "Filters": { @@ -9027,13 +9027,13 @@ "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.\n

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous\n DescribeDBClusterParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" } } }, @@ -9095,7 +9095,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about DB cluster snapshots. This API action supports pagination.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

", + "smithy.api#documentation": "

Returns information about DB cluster snapshots. This API action supports pagination.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -9238,37 +9238,37 @@ "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The ID of the DB cluster to retrieve the list of DB cluster snapshots for. \n This parameter can't be used in conjunction with the\n DBClusterSnapshotIdentifier parameter.\n This parameter isn't case-sensitive.\n

\n

Constraints:

\n " + "smithy.api#documentation": "

The ID of the DB cluster to retrieve the list of DB cluster snapshots for. \n This parameter can't be used in conjunction with the\n DBClusterSnapshotIdentifier parameter.\n This parameter isn't case-sensitive.

\n

Constraints:

\n " } }, "DBClusterSnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

A specific DB cluster snapshot identifier to describe. \n This parameter can't be used in conjunction with the\n DBClusterIdentifier parameter. \n This value is stored as a lowercase string.\n

\n

Constraints:

\n " + "smithy.api#documentation": "

A specific DB cluster snapshot identifier to describe. \n This parameter can't be used in conjunction with the\n DBClusterIdentifier parameter. \n This value is stored as a lowercase string.

\n

Constraints:

\n " } }, "SnapshotType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The type of DB cluster snapshots to be returned. You can specify one of the following values:

\n \n

If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are\n returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared\n parameter. You can include public DB cluster snapshots with these results by enabling the \n IncludePublic parameter.

\n

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values\n of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is\n set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to\n public.

" + "smithy.api#documentation": "

The type of DB cluster snapshots to be returned. You can specify one of the following values:

\n \n

If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are\n returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared\n parameter. You can include public DB cluster snapshots with these results by enabling the \n IncludePublic parameter.

\n

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values\n of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is\n set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to\n public.

" } }, "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { - "smithy.api#documentation": "

A filter that specifies one or more DB cluster snapshots to describe.

\n

Supported filters:

\n " + "smithy.api#documentation": "

A filter that specifies one or more DB cluster snapshots to describe.

\n

Supported filters:

\n " } }, "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.\n

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterSnapshots request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterSnapshots request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" } }, "IncludeShared": { @@ -9302,7 +9302,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

\n

This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

", + "smithy.api#documentation": "

Returns information about Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

\n

This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -9317,25 +9317,25 @@ "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.

\n

Constraints:

\n " + "smithy.api#documentation": "

The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.

\n

Constraints:

\n " } }, "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { - "smithy.api#documentation": "

A filter that specifies one or more DB clusters to describe.

\n

Supported filters:

\n " + "smithy.api#documentation": "

A filter that specifies one or more DB clusters to describe.

\n

Supported filters:

\n " } }, "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.\n

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" } }, "IncludeShared": { @@ -9373,37 +9373,37 @@ "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The database engine to return.

\n

Valid Values:\n

\n " + "smithy.api#documentation": "

The database engine to return.

\n

Valid Values:

\n " } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The database engine version to return.

\n

Example: 5.1.49\n

" + "smithy.api#documentation": "

The database engine version to return.

\n

Example: 5.1.49\n

" } }, "DBParameterGroupFamily": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of a specific DB parameter group family to return details for.

\n

Constraints:

\n " + "smithy.api#documentation": "

The name of a specific DB parameter group family to return details for.

\n

Constraints:

\n " } }, "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { - "smithy.api#documentation": "

A filter that specifies one or more DB engine versions to describe.

\n

Supported filters:

\n " + "smithy.api#documentation": "

A filter that specifies one or more DB engine versions to describe.

\n

Supported filters:

\n " } }, "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

\n The maximum number of records to include in the response.\n If more than the MaxRecords value is available, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.\n

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more than the MaxRecords value is available, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" } }, "DefaultOnly": { @@ -9415,13 +9415,13 @@ "ListSupportedCharacterSets": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to list the supported character sets for each engine version.

\n

If this parameter is enabled and the requested engine supports the CharacterSetName parameter for\n CreateDBInstance, the response includes a list of supported character sets for each engine\n version.

\n

For RDS Custom, the default is not to list supported character sets. If you set ListSupportedCharacterSets\n to true, RDS Custom returns no results.\n

" + "smithy.api#documentation": "

A value that indicates whether to list the supported character sets for each engine version.

\n

If this parameter is enabled and the requested engine supports the CharacterSetName parameter for\n CreateDBInstance, the response includes a list of supported character sets for each engine\n version.

\n

For RDS Custom, the default is not to list supported character sets. If you set ListSupportedCharacterSets\n to true, RDS Custom returns no results.

" } }, "ListSupportedTimezones": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to list the supported time zones for each engine version.

\n

If this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance, \n the response includes a list of supported time zones for each engine version.\n

\n

For RDS Custom, the default is not to list supported time zones. If you set ListSupportedTimezones\n to true, RDS Custom returns no results.\n

" + "smithy.api#documentation": "

A value that indicates whether to list the supported time zones for each engine version.

\n

If this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance, \n the response includes a list of supported time zones for each engine version.

\n

For RDS Custom, the default is not to list supported time zones. If you set ListSupportedTimezones\n to true, RDS Custom returns no results.

" } }, "IncludeAll": { @@ -9446,7 +9446,7 @@ } ], "traits": { - "smithy.api#documentation": "

Displays backups for both current and deleted\n instances. For example, use this operation to\n find details about automated backups for previously deleted instances. Current instances\n with retention periods greater than zero (0) are returned for both the \n DescribeDBInstanceAutomatedBackups and\n DescribeDBInstances operations.

\n\t

All parameters are optional.

", + "smithy.api#documentation": "

Displays backups for both current and deleted\n instances. For example, use this operation to\n find details about automated backups for previously deleted instances. Current instances\n with retention periods greater than zero (0) are returned for both the \n DescribeDBInstanceAutomatedBackups and\n DescribeDBInstances operations.

\n

All parameters are optional.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -9461,31 +9461,31 @@ "DbiResourceId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The resource ID of the DB instance that is the source of \n\t\t the automated backup. This parameter isn't case-sensitive.

" + "smithy.api#documentation": "

The resource ID of the DB instance that is the source of \n the automated backup. This parameter isn't case-sensitive.

" } }, "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

(Optional) The user-supplied instance identifier. If this parameter is specified, it must\n match the identifier of an existing DB instance. It returns information from the\n specific DB instance' automated backup. This parameter isn't case-sensitive.

" + "smithy.api#documentation": "

(Optional) The user-supplied instance identifier. If this parameter is specified, it must\n match the identifier of an existing DB instance. It returns information from the\n specific DB instance' automated backup. This parameter isn't case-sensitive.

" } }, "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { - "smithy.api#documentation": "

A filter that specifies which resources to return based on status.

\n\t\t

Supported filters are the following:

\n\t\t \n\t\t

Returns all resources by default. The status for each resource is specified in the response.

" + "smithy.api#documentation": "

A filter that specifies which resources to return based on status.

\n

Supported filters are the following:

\n \n

Returns all resources by default. The status for each resource is specified in the response.

" } }, "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified \n\t\t\tMaxRecords value, a pagination token called a marker is included in the response so that \n\t\t\tyou can retrieve the remaining results.

" + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified \n MaxRecords value, a pagination token called a marker is included in the response so that \n you can retrieve the remaining results.

" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The pagination token provided in the previous request. If this parameter is specified the response \n\t\t\tincludes only records beyond the marker, up to MaxRecords.

" + "smithy.api#documentation": "

The pagination token provided in the previous request. If this parameter is specified the response \n includes only records beyond the marker, up to MaxRecords.

" } }, "DBInstanceAutomatedBackupsArn": { @@ -9496,7 +9496,7 @@ } }, "traits": { - "smithy.api#documentation": "

Parameter input for DescribeDBInstanceAutomatedBackups.

" + "smithy.api#documentation": "

Parameter input for DescribeDBInstanceAutomatedBackups.

" } }, "com.amazonaws.rds#DescribeDBInstances": { @@ -9513,7 +9513,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about provisioned RDS instances. This API supports pagination.

\n \n

This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

\n ", + "smithy.api#documentation": "

Returns information about provisioned RDS instances. This API supports pagination.

\n \n

This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

\n ", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -9657,25 +9657,25 @@ "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive.

\n

Constraints:

\n " + "smithy.api#documentation": "

The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive.

\n

Constraints:

\n " } }, "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { - "smithy.api#documentation": "

A filter that specifies one or more DB instances to describe.

\n

Supported filters:

\n " + "smithy.api#documentation": "

A filter that specifies one or more DB instances to describe.

\n

Supported filters:

\n " } }, "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.\n

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous\n DescribeDBInstances request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBInstances request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" } } }, @@ -9697,7 +9697,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of DB log files for the DB instance.

\n

This command doesn't apply to RDS Custom.

", + "smithy.api#documentation": "

Returns a list of DB log files for the DB instance.

\n

This command doesn't apply to RDS Custom.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -9747,7 +9747,7 @@ "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The customer-assigned name of the DB instance that contains the log files you want to list.

\n

Constraints:

\n ", + "smithy.api#documentation": "

The customer-assigned name of the DB instance that contains the log files you want to list.

\n

Constraints:

\n ", "smithy.api#required": {} } }, @@ -9804,12 +9804,12 @@ "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a later DescribeDBLogFiles request.

" + "smithy.api#documentation": "

A pagination token that can be used in a later DescribeDBLogFiles request.

" } } }, "traits": { - "smithy.api#documentation": "

\n The response from a call to DescribeDBLogFiles.\n

" + "smithy.api#documentation": "

The response from a call to DescribeDBLogFiles.

" } }, "com.amazonaws.rds#DescribeDBParameterGroups": { @@ -9826,7 +9826,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified,\n the list will contain only the description of the specified DB parameter group.\n

", + "smithy.api#documentation": "

Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified,\n the list will contain only the description of the specified DB parameter group.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -9841,7 +9841,7 @@ "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of a specific DB parameter group to return details for.

\n

Constraints:

\n " + "smithy.api#documentation": "

The name of a specific DB parameter group to return details for.

\n

Constraints:

\n " } }, "Filters": { @@ -9853,13 +9853,13 @@ "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.\n

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous\n DescribeDBParameterGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBParameterGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" } } }, @@ -9896,14 +9896,14 @@ "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of a specific DB parameter group to return details for.

\n

Constraints:

\n ", + "smithy.api#documentation": "

The name of a specific DB parameter group to return details for.

\n

Constraints:

\n ", "smithy.api#required": {} } }, "Source": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The parameter types to return.

\n

Default: All parameter types returned

\n

Valid Values: user | system | engine-default\n

" + "smithy.api#documentation": "

The parameter types to return.

\n

Default: All parameter types returned

\n

Valid Values: user | system | engine-default\n

" } }, "Filters": { @@ -9915,13 +9915,13 @@ "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.\n

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous\n DescribeDBParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" } } } @@ -9967,13 +9967,13 @@ "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" } }, "MaxRecords": { "target": "com.amazonaws.rds#MaxRecords", "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist\n than the specified MaxRecords value, a pagination token called a marker is\n included in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist\n than the specified MaxRecords value, a pagination token called a marker is\n included in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } } } @@ -9990,7 +9990,7 @@ "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" } } } @@ -10045,13 +10045,13 @@ "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" } }, "MaxRecords": { "target": "com.amazonaws.rds#MaxRecords", "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist\n than the specified MaxRecords value, a pagination token called a marker is\n included in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist\n than the specified MaxRecords value, a pagination token called a marker is\n included in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } } } @@ -10068,7 +10068,7 @@ "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" } } } @@ -10127,13 +10127,13 @@ "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" } }, "MaxRecords": { "target": "com.amazonaws.rds#MaxRecords", "traits": { - "smithy.api#documentation": "

\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that the remaining\n results can be retrieved.\n

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that the remaining\n results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } } } @@ -10150,7 +10150,7 @@ "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" } } } @@ -10212,13 +10212,13 @@ "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" } }, "MaxRecords": { "target": "com.amazonaws.rds#MaxRecords", "traits": { - "smithy.api#documentation": "

\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that the remaining\n results can be retrieved.\n

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that the remaining\n results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } } } @@ -10235,7 +10235,7 @@ "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" } } } @@ -10254,7 +10254,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified,\n the list will contain only the descriptions of the specified DB security group.\n

", + "smithy.api#documentation": "

Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified,\n the list will contain only the descriptions of the specified DB security group.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -10281,13 +10281,13 @@ "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.\n

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous\n DescribeDBSecurityGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBSecurityGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" } } }, @@ -10309,7 +10309,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of DB snapshot attribute names and values for a manual DB snapshot.

\n

When sharing snapshots with other Amazon Web Services accounts, DescribeDBSnapshotAttributes\n returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are \n authorized to copy or restore the manual DB snapshot. If all is included in the list of\n values for the restore attribute, then the manual DB snapshot is public and\n can be copied or restored by all Amazon Web Services accounts.

\n

To add or remove access for an Amazon Web Services account to copy or restore a manual DB snapshot, or to make the\n manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.

" + "smithy.api#documentation": "

Returns a list of DB snapshot attribute names and values for a manual DB snapshot.

\n

When sharing snapshots with other Amazon Web Services accounts, DescribeDBSnapshotAttributes\n returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are \n authorized to copy or restore the manual DB snapshot. If all is included in the list of\n values for the restore attribute, then the manual DB snapshot is public and\n can be copied or restored by all Amazon Web Services accounts.

\n

To add or remove access for an Amazon Web Services account to copy or restore a manual DB snapshot, or to make the\n manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.

" } }, "com.amazonaws.rds#DescribeDBSnapshotAttributesMessage": { @@ -10493,49 +10493,49 @@ "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The ID of the DB instance to retrieve the list of DB snapshots for. \n This parameter can't be used in conjunction with DBSnapshotIdentifier.\n This parameter isn't case-sensitive.\n

\n

Constraints:

\n " + "smithy.api#documentation": "

The ID of the DB instance to retrieve the list of DB snapshots for. \n This parameter can't be used in conjunction with DBSnapshotIdentifier.\n This parameter isn't case-sensitive.

\n

Constraints:

\n " } }, "DBSnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n A specific DB snapshot identifier to describe. This parameter can't be used in conjunction with DBInstanceIdentifier. \n This value is stored as a lowercase string.\n

\n

Constraints:

\n " + "smithy.api#documentation": "

A specific DB snapshot identifier to describe. This parameter can't be used in conjunction with DBInstanceIdentifier. \n This value is stored as a lowercase string.

\n

Constraints:

\n " } }, "SnapshotType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The type of snapshots to be returned. You can specify one of the following values:

\n \n

If you don't specify a SnapshotType value, then both automated and manual snapshots are\n returned. Shared and public DB snapshots are not included in the returned results by default.\n You can include shared snapshots with these results by enabling the IncludeShared\n parameter. You can include public snapshots with these results by enabling the \n IncludePublic parameter.

\n

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values\n of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is\n set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to\n public.

" + "smithy.api#documentation": "

The type of snapshots to be returned. You can specify one of the following values:

\n \n

If you don't specify a SnapshotType value, then both automated and manual snapshots are\n returned. Shared and public DB snapshots are not included in the returned results by default.\n You can include shared snapshots with these results by enabling the IncludeShared\n parameter. You can include public snapshots with these results by enabling the \n IncludePublic parameter.

\n

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values\n of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is\n set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to\n public.

" } }, "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { - "smithy.api#documentation": "

A filter that specifies one or more DB snapshots to describe.

\n

Supported filters:

\n " + "smithy.api#documentation": "

A filter that specifies one or more DB snapshots to describe.

\n

Supported filters:

\n " } }, "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.\n

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous\n DescribeDBSnapshots request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBSnapshots request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" } }, "IncludeShared": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

A value that indicates whether to include shared manual DB cluster snapshots \n from other Amazon Web Services accounts that this Amazon Web Services account has been given \n permission to copy or restore. By default, these snapshots are not included.

\n

You can give an Amazon Web Services account permission to restore a manual DB snapshot from\n another Amazon Web Services account by using the ModifyDBSnapshotAttribute API action.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

A value that indicates whether to include shared manual DB cluster snapshots \n from other Amazon Web Services accounts that this Amazon Web Services account has been given \n permission to copy or restore. By default, these snapshots are not included.

\n

You can give an Amazon Web Services account permission to restore a manual DB snapshot from\n another Amazon Web Services account by using the ModifyDBSnapshotAttribute API action.

\n

This setting doesn't apply to RDS Custom.

" } }, "IncludePublic": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

A value that indicates whether to include manual DB cluster snapshots that are public and can be copied \n or restored by any Amazon Web Services account. By default, the public snapshots are not included.

\n

You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

A value that indicates whether to include manual DB cluster snapshots that are public and can be copied \n or restored by any Amazon Web Services account. By default, the public snapshots are not included.

\n

You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

\n

This setting doesn't apply to RDS Custom.

" } }, "DbiResourceId": { @@ -10563,7 +10563,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

\n

For an overview of CIDR ranges, go to the \n Wikipedia Tutorial.\n

", + "smithy.api#documentation": "

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

\n

For an overview of CIDR ranges, go to the \n Wikipedia Tutorial.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -10590,13 +10590,13 @@ "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.\n

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous DescribeDBSubnetGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeDBSubnetGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" } } }, @@ -10613,7 +10613,7 @@ "target": "com.amazonaws.rds#DescribeEngineDefaultClusterParametersResult" }, "traits": { - "smithy.api#documentation": "

Returns the default engine and system parameter information for the cluster database engine.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n

" + "smithy.api#documentation": "

Returns the default engine and system parameter information for the cluster database engine.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

" } }, "com.amazonaws.rds#DescribeEngineDefaultClusterParametersMessage": { @@ -10635,13 +10635,13 @@ "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.\n

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous\n DescribeEngineDefaultClusterParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeEngineDefaultClusterParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" } } }, @@ -10694,13 +10694,13 @@ "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.\n

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous\n DescribeEngineDefaultParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeEngineDefaultParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" } } }, @@ -10725,7 +10725,7 @@ "target": "com.amazonaws.rds#EventCategoriesMessage" }, "traits": { - "smithy.api#documentation": "

Displays a list of categories for all event source types, or, if specified, for a specified source type.\n You can also see this list in the \"Amazon RDS event categories and event messages\" section of the \n Amazon RDS User Guide\n or the\n \n Amazon Aurora User Guide\n .\n

" + "smithy.api#documentation": "

Displays a list of categories for all event source types, or, if specified, for a specified source type.\n You can also see this list in the \"Amazon RDS event categories and event messages\" section of the \n Amazon RDS User Guide\n or the\n \n Amazon Aurora User Guide\n .

" } }, "com.amazonaws.rds#DescribeEventCategoriesMessage": { @@ -10734,7 +10734,7 @@ "SourceType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The type of source that is generating the events. For RDS Proxy events, specify db-proxy.

\n

Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n

" + "smithy.api#documentation": "

The type of source that is generating the events. For RDS Proxy events, specify db-proxy.

\n

Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n

" } }, "Filters": { @@ -10762,7 +10762,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all the subscription descriptions for a customer account. The description for a subscription includes \n SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

\n

If you specify a SubscriptionName, lists the description for that subscription.

", + "smithy.api#documentation": "

Lists all the subscription descriptions for a customer account. The description for a subscription includes \n SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

\n

If you specify a SubscriptionName, lists the description for that subscription.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -10789,13 +10789,13 @@ "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.\n

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous\n DescribeOrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeOrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .

" } } }, @@ -10812,7 +10812,7 @@ "target": "com.amazonaws.rds#EventsMessage" }, "traits": { - "smithy.api#documentation": "

Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. \n Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be \n obtained by providing the name as a parameter.

\n \n

By default, RDS returns events that were generated in the past hour.

\n ", + "smithy.api#documentation": "

Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. \n Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be \n obtained by providing the name as a parameter.

\n \n

By default, RDS returns events that were generated in the past hour.

\n ", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -10827,7 +10827,7 @@ "SourceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.

\n

Constraints:

\n " + "smithy.api#documentation": "

The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.

\n

Constraints:

\n " } }, "SourceType": { @@ -10839,19 +10839,19 @@ "StartTime": { "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

\n The beginning of the time interval to retrieve events for,\n specified in ISO 8601 format. For more information about ISO 8601, \n go to the ISO8601 Wikipedia page.\n

\n

Example: 2009-07-08T18:00Z

" + "smithy.api#documentation": "

The beginning of the time interval to retrieve events for,\n specified in ISO 8601 format. For more information about ISO 8601, \n go to the ISO8601 Wikipedia page.\n

\n

Example: 2009-07-08T18:00Z

" } }, "EndTime": { "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

\n The end of the time interval for which to retrieve events,\n specified in ISO 8601 format. For more information about ISO 8601, \n go to the ISO8601 Wikipedia page.\n

\n

Example: 2009-07-08T18:00Z

" + "smithy.api#documentation": "

The end of the time interval for which to retrieve events,\n specified in ISO 8601 format. For more information about ISO 8601, \n go to the ISO8601 Wikipedia page.\n

\n

Example: 2009-07-08T18:00Z

" } }, "Duration": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of minutes to retrieve events for.

\n

Default: 60

" + "smithy.api#documentation": "

The number of minutes to retrieve events for.

\n

Default: 60

" } }, "EventCategories": { @@ -10869,13 +10869,13 @@ "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.\n

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous\n DescribeEvents request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeEvents request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" } } }, @@ -10897,7 +10897,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about a snapshot export to Amazon S3. This API operation supports\n pagination.

", + "smithy.api#documentation": "

Returns information about a snapshot export to Amazon S3. This API operation supports\n pagination.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -10924,19 +10924,19 @@ "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { - "smithy.api#documentation": "

Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to\n include in the output. Filter names and values are case-sensitive.

\n

Supported filters include the following:

\n " + "smithy.api#documentation": "

Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to\n include in the output. Filter names and values are case-sensitive.

\n

Supported filters include the following:

\n " } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous DescribeExportTasks request.\n If you specify this parameter, the response includes only records beyond the marker,\n up to the value specified by the MaxRecords parameter.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeExportTasks request.\n If you specify this parameter, the response includes only records beyond the marker,\n up to the value specified by the MaxRecords parameter.

" } }, "MaxRecords": { "target": "com.amazonaws.rds#MaxRecords", "traits": { - "smithy.api#documentation": "

\n The maximum number of records to include in the response. If more records exist than the \n specified value, a pagination token called a marker is included in the response. \n You can use the marker in a later DescribeExportTasks request \n to retrieve the remaining results.\n

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the \n specified value, a pagination token called a marker is included in the response. \n You can use the marker in a later DescribeExportTasks request \n to retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } } } @@ -10955,7 +10955,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Returns information about Aurora global database clusters. This API supports pagination.\n

\n

\n For more information on Amazon Aurora, see What is Amazon Aurora? in the\n Amazon Aurora User Guide.\n

\n \n

This action only applies to Aurora DB clusters.

\n ", + "smithy.api#documentation": "

Returns information about Aurora global database clusters. This API supports pagination.

\n

For more information on Amazon Aurora, see What is Amazon Aurora? in the\n Amazon Aurora User Guide.

\n \n

This action only applies to Aurora DB clusters.

\n ", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -10970,7 +10970,7 @@ "GlobalClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.\n

\n

Constraints:

\n " + "smithy.api#documentation": "

The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.

\n

Constraints:

\n " } }, "Filters": { @@ -10982,13 +10982,13 @@ "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

\n The maximum number of records to include in the response. If more records exist than the specified\n MaxRecords value, a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.\n

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified\n MaxRecords value, a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous DescribeGlobalClusters request. If\n this parameter is specified, the response includes only records beyond the marker, up to the value\n specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeGlobalClusters request. If\n this parameter is specified, the response includes only records beyond the marker, up to the value\n specified by MaxRecords.

" } } } @@ -11028,7 +11028,7 @@ "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { - "smithy.api#documentation": "

A filter that specifies one or more installation media to describe. Supported filters\n include the following:

\n " + "smithy.api#documentation": "

A filter that specifies one or more installation media to describe. Supported filters\n include the following:

\n " } }, "MaxRecords": { @@ -11069,7 +11069,7 @@ "EngineName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

A required parameter. Options available for the given engine name are described.

\n

Valid Values:\n

\n ", + "smithy.api#documentation": "

A required parameter. Options available for the given engine name are described.

\n

Valid Values:

\n ", "smithy.api#required": {} } }, @@ -11088,7 +11088,7 @@ "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.\n

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, "Marker": { @@ -11143,19 +11143,19 @@ "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous DescribeOptionGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeOptionGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" } }, "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.\n

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, "EngineName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Filters the list of option groups to only include groups associated with a specific database engine.

\n

Valid Values:\n

\n " + "smithy.api#documentation": "

Filters the list of option groups to only include groups associated with a specific database engine.

\n

Valid Values:

\n " } }, "MajorEngineVersion": { @@ -11193,7 +11193,7 @@ "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the engine to retrieve DB instance options for.

\n

Valid Values:\n

\n ", + "smithy.api#documentation": "

The name of the engine to retrieve DB instance options for.

\n

Valid Values:

\n ", "smithy.api#required": {} } }, @@ -11212,19 +11212,19 @@ "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The license model filter value. Specify this parameter to show only the available offerings \n matching the specified license model.

\n

RDS Custom supports only the BYOL licensing model.

" + "smithy.api#documentation": "

The license model filter value. Specify this parameter to show only the available offerings \n matching the specified license model.

\n

RDS Custom supports only the BYOL licensing model.

" } }, "AvailabilityZoneGroup": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group.

\n

Omit this parameter to show the available offerings in the specified Amazon Web Services Region.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group.

\n

Omit this parameter to show the available offerings in the specified Amazon Web Services Region.

\n

This setting doesn't apply to RDS Custom.

" } }, "Vpc": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to show only VPC or non-VPC offerings. RDS Custom supports \n only VPC offerings.

\n

RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output \n shows VPC offerings.

" + "smithy.api#documentation": "

A value that indicates whether to show only VPC or non-VPC offerings. RDS Custom supports \n only VPC offerings.

\n

RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output \n shows VPC offerings.

" } }, "Filters": { @@ -11236,13 +11236,13 @@ "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.\n

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous\n DescribeOrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeOrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" } } }, @@ -11285,19 +11285,19 @@ "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { - "smithy.api#documentation": "

A filter that specifies one or more resources to return pending maintenance actions for.

\n

Supported filters:

\n " + "smithy.api#documentation": "

A filter that specifies one or more resources to return pending maintenance actions for.

\n

Supported filters:

\n " } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous\n DescribePendingMaintenanceActions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to a number of records specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribePendingMaintenanceActions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to a number of records specified by MaxRecords.

" } }, "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.\n

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } } }, @@ -11352,7 +11352,7 @@ "Duration": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

\n

Valid Values: 1 | 3 | 31536000 | 94608000\n

" + "smithy.api#documentation": "

The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

\n

Valid Values: 1 | 3 | 31536000 | 94608000\n

" } }, "ProductDescription": { @@ -11364,7 +11364,7 @@ "OfferingType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

\n

Valid Values: \"Partial Upfront\" | \"All Upfront\" | \"No Upfront\" \n

" + "smithy.api#documentation": "

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

\n

Valid Values: \"Partial Upfront\" | \"All Upfront\" | \"No Upfront\" \n

" } }, "MultiAZ": { @@ -11376,7 +11376,7 @@ "LeaseId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID.

\n \n

Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.

\n " + "smithy.api#documentation": "

The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID.

\n \n

Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.

\n " } }, "Filters": { @@ -11388,13 +11388,13 @@ "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

\n The maximum number of records to include in the response.\n If more than the MaxRecords value is available, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.\n

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more than the MaxRecords value is available, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" } } }, @@ -11431,7 +11431,7 @@ "ReservedDBInstancesOfferingId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.

\n

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706\n

" + "smithy.api#documentation": "

The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.

\n

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706\n

" } }, "DBInstanceClass": { @@ -11443,19 +11443,19 @@ "Duration": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

\n

Valid Values: 1 | 3 | 31536000 | 94608000\n

" + "smithy.api#documentation": "

Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

\n

Valid Values: 1 | 3 | 31536000 | 94608000\n

" } }, "ProductDescription": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Product description filter value. Specify this parameter to show only the available offerings that contain the specified product description.

\n \n

The results show offerings that partially match the filter value.

\n " + "smithy.api#documentation": "

Product description filter value. Specify this parameter to show only the available offerings that contain the specified product description.

\n \n

The results show offerings that partially match the filter value.

\n " } }, "OfferingType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

\n

Valid Values: \"Partial Upfront\" | \"All Upfront\" | \"No Upfront\" \n

" + "smithy.api#documentation": "

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

\n

Valid Values: \"Partial Upfront\" | \"All Upfront\" | \"No Upfront\" \n

" } }, "MultiAZ": { @@ -11473,13 +11473,13 @@ "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

\n The maximum number of records to include in the response.\n If more than the MaxRecords value is available, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.\n

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more than the MaxRecords value is available, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" } } }, @@ -11517,7 +11517,7 @@ "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist\n than the specified MaxRecords value, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist\n than the specified MaxRecords value, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, "Marker": { @@ -11554,7 +11554,7 @@ } ], "traits": { - "smithy.api#documentation": "

You can call DescribeValidDBInstanceModifications to learn what modifications you can make to \n your DB instance. You can use this information when you call ModifyDBInstance.\n

\n

This command doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

You can call DescribeValidDBInstanceModifications to learn what modifications you can make to \n your DB instance. You can use this information when you call ModifyDBInstance.

\n

This command doesn't apply to RDS Custom.

" } }, "com.amazonaws.rds#DescribeValidDBInstanceModificationsMessage": { @@ -11563,7 +11563,7 @@ "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The customer identifier or the ARN of your DB instance.\n

", + "smithy.api#documentation": "

The customer identifier or the ARN of your DB instance.

", "smithy.api#required": {} } } @@ -11629,9 +11629,6 @@ "traits": { "smithy.api#xmlName": "DomainMembership" } - }, - "traits": { - "smithy.api#documentation": "

List of Active Directory Domain membership records associated with a DB instance or cluster.

" } }, "com.amazonaws.rds#DomainNotFoundFault": { @@ -11646,7 +11643,7 @@ "code": "DomainNotFoundFault", "httpResponseCode": 404 }, - "smithy.api#documentation": "

\n Domain doesn't refer to an existing Active Directory domain.\n

", + "smithy.api#documentation": "

\n Domain doesn't refer to an existing Active Directory domain.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -11706,7 +11703,7 @@ } ], "traits": { - "smithy.api#documentation": "

Downloads all or a portion of the specified log file, up to 1 MB in size.

\n

This command doesn't apply to RDS Custom.

", + "smithy.api#documentation": "

Downloads all or a portion of the specified log file, up to 1 MB in size.

\n

This command doesn't apply to RDS Custom.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -11726,7 +11723,7 @@ "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a later DownloadDBLogFilePortion request.

" + "smithy.api#documentation": "

A pagination token that can be used in a later DownloadDBLogFilePortion request.

" } }, "AdditionalDataPending": { @@ -11746,7 +11743,7 @@ "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The customer-assigned name of the DB instance that contains the log files you want to list.

\n

Constraints:

\n ", + "smithy.api#documentation": "

The customer-assigned name of the DB instance that contains the log files you want to list.

\n

Constraints:

\n ", "smithy.api#required": {} } }, @@ -11766,7 +11763,7 @@ "NumberOfLines": { "target": "com.amazonaws.rds#Integer", "traits": { - "smithy.api#documentation": "

The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file is truncated at 1 MB in size.

\n

If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning \n or the end of the log file, depending on the value of the Marker parameter.

\n " + "smithy.api#documentation": "

The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file is truncated at 1 MB in size.

\n

If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning \n or the end of the log file, depending on the value of the Marker parameter.

\n " } } }, @@ -11798,12 +11795,12 @@ "EC2SecurityGroupOwnerId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n Specifies the Amazon Web Services ID of the owner of the EC2 security group\n specified in the EC2SecurityGroupName field.\n

" + "smithy.api#documentation": "

Specifies the Amazon Web Services ID of the owner of the EC2 security group\n specified in the EC2SecurityGroupName field.

" } } }, "traits": { - "smithy.api#documentation": "

This data type is used as a response element in the following actions:

\n " + "smithy.api#documentation": "

This data type is used as a response element in the following actions:

\n " } }, "com.amazonaws.rds#EC2SecurityGroupList": { @@ -11838,7 +11835,7 @@ } }, "traits": { - "smithy.api#documentation": "

This data type represents the information you need to connect to an Amazon RDS DB instance.\n This data type is used as a response element in the following actions:

\n \n

For the data structure that represents Amazon Aurora DB cluster endpoints,\n see DBClusterEndpoint.

" + "smithy.api#documentation": "

This data type represents the information you need to connect to an Amazon RDS DB instance.\n This data type is used as a response element in the following actions:

\n \n

For the data structure that represents Amazon Aurora DB cluster endpoints,\n see DBClusterEndpoint.

" } }, "com.amazonaws.rds#EngineDefaults": { @@ -11853,7 +11850,7 @@ "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous \n EngineDefaults request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous \n EngineDefaults request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .

" } }, "Parameters": { @@ -11864,7 +11861,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.\n

" + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.

" } }, "com.amazonaws.rds#EngineFamily": { @@ -11929,7 +11926,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n This data type is used as a response element in the DescribeEvents action.\n

" + "smithy.api#documentation": "

This data type is used as a response element in the DescribeEvents action.

" } }, "com.amazonaws.rds#EventCategoriesList": { @@ -11976,7 +11973,7 @@ "EventCategoriesMapList": { "target": "com.amazonaws.rds#EventCategoriesMapList", "traits": { - "smithy.api#documentation": "

A list of EventCategoriesMap data types.

" + "smithy.api#documentation": "

A list of EventCategoriesMap data types.

" } } }, @@ -12017,7 +12014,7 @@ "Status": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The status of the RDS event notification subscription.

\n

Constraints:

\n

Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

\n

The status \"no-permission\" indicates that RDS no longer has permission to post to the SNS topic. The status \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.

" + "smithy.api#documentation": "

The status of the RDS event notification subscription.

\n

Constraints:

\n

Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

\n

The status \"no-permission\" indicates that RDS no longer has permission to post to the SNS topic. The status \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.

" } }, "SubscriptionCreationTime": { @@ -12093,7 +12090,7 @@ "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous\n DescribeOrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeOrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" } }, "EventSubscriptionsList": { @@ -12113,18 +12110,18 @@ "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous \n Events request.\n If this parameter is specified, the response includes\n only records beyond the marker, \n up to the value specified by MaxRecords .\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous \n Events request.\n If this parameter is specified, the response includes\n only records beyond the marker, \n up to the value specified by MaxRecords.

" } }, "Events": { "target": "com.amazonaws.rds#EventList", "traits": { - "smithy.api#documentation": "

\n A list of Event instances.\n

" + "smithy.api#documentation": "

A list of Event instances.

" } } }, "traits": { - "smithy.api#documentation": "

\n Contains the result of a successful invocation of the DescribeEvents action.\n

" + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeEvents action.

" } }, "com.amazonaws.rds#ExceptionMessage": { @@ -12136,7 +12133,7 @@ "ExportTaskIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

A unique identifier for the snapshot export task. This ID isn't an identifier for\n the Amazon S3 bucket where the snapshot is exported to.

" + "smithy.api#documentation": "

A unique identifier for the snapshot export task. This ID isn't an identifier for\n the Amazon S3 bucket where the snapshot is exported to.

" } }, "SourceArn": { @@ -12148,7 +12145,7 @@ "ExportOnly": { "target": "com.amazonaws.rds#StringList", "traits": { - "smithy.api#documentation": "

The data exported from the snapshot. Valid values are the following:

\n " + "smithy.api#documentation": "

The data exported from the snapshot. Valid values are the following:

\n " } }, "SnapshotTime": { @@ -12184,13 +12181,13 @@ "IamRoleArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.

" + "smithy.api#documentation": "

The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.

" } }, "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The key identifier of the Amazon Web Services KMS key that is used to encrypt the snapshot when it's exported to\n Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the snapshot export\n must have encryption and decryption permissions to use this KMS key.

" + "smithy.api#documentation": "

The key identifier of the Amazon Web Services KMS key that is used to encrypt the snapshot when it's exported to\n Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the snapshot export\n must have encryption and decryption permissions to use this KMS key.

" } }, "Status": { @@ -12225,7 +12222,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains the details of a snapshot export to Amazon S3.\n

\n

This data type is used as a response element in the DescribeExportTasks action.\n

" + "smithy.api#documentation": "

Contains the details of a snapshot export to Amazon S3.

\n

This data type is used as a response element in the DescribeExportTasks action.

" } }, "com.amazonaws.rds#ExportTaskAlreadyExistsFault": { @@ -12308,7 +12305,7 @@ } ], "traits": { - "smithy.api#documentation": "

Forces a failover for a DB cluster.

\n

For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances)\n in the DB cluster to be the primary DB instance (the cluster writer).

\n

For a Multi-AZ DB cluster, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances)\n in the DB cluster to be the primary DB instance (the cluster writer).

\n

An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists,\n when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readbable standby \n DB instance when the primary DB instance fails.

\n

To simulate a failure of a primary instance for testing, you can force a failover. \n Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing \n connections that use those endpoint addresses when the failover is complete.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

Forces a failover for a DB cluster.

\n

For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances)\n in the DB cluster to be the primary DB instance (the cluster writer).

\n

For a Multi-AZ DB cluster, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances)\n in the DB cluster to be the primary DB instance (the cluster writer).

\n

An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists,\n when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readbable standby \n DB instance when the primary DB instance fails.

\n

To simulate a failure of a primary instance for testing, you can force a failover. \n Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing \n connections that use those endpoint addresses when the failover is complete.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

" } }, "com.amazonaws.rds#FailoverDBClusterMessage": { @@ -12317,7 +12314,7 @@ "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

A DB cluster identifier to force a failover for. This parameter isn't case-sensitive.

\n

Constraints:

\n ", + "smithy.api#documentation": "

A DB cluster identifier to force a failover for. This parameter isn't case-sensitive.

\n

Constraints:

\n ", "smithy.api#required": {} } }, @@ -12363,7 +12360,7 @@ } ], "traits": { - "smithy.api#documentation": "

Initiates the failover process for an Aurora global database (GlobalCluster).

\n

A failover for an Aurora global database promotes one of secondary read-only DB clusters to be\n the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words,\n the role of the current primary DB cluster and the selected (target) DB cluster are switched. The selected\n secondary DB cluster assumes full read/write capabilities for the Aurora global database.

\n

For more information about failing over an Amazon Aurora global database, see\n Managed planned failover for Amazon Aurora global\n databases in the Amazon Aurora User Guide.\n

\n \n

This action applies to GlobalCluster (Aurora global databases) only. Use this action only on\n healthy Aurora global databases with running Aurora DB clusters and no Region-wide outages, to test disaster recovery scenarios or to\n reconfigure your Aurora global database topology.\n

\n " + "smithy.api#documentation": "

Initiates the failover process for an Aurora global database (GlobalCluster).

\n

A failover for an Aurora global database promotes one of secondary read-only DB clusters to be\n the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words,\n the role of the current primary DB cluster and the selected (target) DB cluster are switched. The selected\n secondary DB cluster assumes full read/write capabilities for the Aurora global database.

\n

For more information about failing over an Amazon Aurora global database, see\n Managed planned failover for Amazon Aurora global\n databases in the Amazon Aurora User Guide.

\n \n

This action applies to GlobalCluster (Aurora global databases) only. Use this action only on\n healthy Aurora global databases with running Aurora DB clusters and no Region-wide outages, to test disaster recovery scenarios or to\n reconfigure your Aurora global database topology.

\n " } }, "com.amazonaws.rds#FailoverGlobalClusterMessage": { @@ -12372,14 +12369,14 @@ "GlobalClusterIdentifier": { "target": "com.amazonaws.rds#GlobalClusterIdentifier", "traits": { - "smithy.api#documentation": "

Identifier of the Aurora global database (GlobalCluster)\n that should be failed over. The identifier is the unique key assigned by\n the user when the Aurora global database was created. In other words,\n it's the name of the Aurora global database that you want to fail over.

\n

Constraints:

\n ", + "smithy.api#documentation": "

Identifier of the Aurora global database (GlobalCluster)\n that should be failed over. The identifier is the unique key assigned by\n the user when the Aurora global database was created. In other words,\n it's the name of the Aurora global database that you want to fail over.

\n

Constraints:

\n ", "smithy.api#required": {} } }, "TargetDbClusterIdentifier": { "target": "com.amazonaws.rds#DBClusterIdentifier", "traits": { - "smithy.api#documentation": "

Identifier of the secondary Aurora DB cluster that you want to promote to primary for the Aurora\n global database (GlobalCluster.) Use the Amazon Resource Name (ARN) for the identifier so that\n Aurora can locate the cluster in its Amazon Web Services Region. \n

", + "smithy.api#documentation": "

Identifier of the secondary Aurora DB cluster that you want to promote to primary for the Aurora\n global database (GlobalCluster.) Use the Amazon Resource Name (ARN) for the identifier so that\n Aurora can locate the cluster in its Amazon Web Services Region.

", "smithy.api#required": {} } } @@ -12399,13 +12396,13 @@ "Status": { "target": "com.amazonaws.rds#FailoverStatus", "traits": { - "smithy.api#documentation": "

The current status of the Aurora global database (GlobalCluster). Possible values are as follows:\n

\n " + "smithy.api#documentation": "

The current status of the Aurora global database (GlobalCluster). Possible values are as follows:

\n " } }, "FromDbClusterArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this\n state.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this\n state.

" } }, "ToDbClusterArn": { @@ -12416,7 +12413,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains the state of scheduled or in-process failover operations on an\n Aurora global database (GlobalCluster). This Data type is empty unless a failover\n operation is scheduled or is currently underway on the Aurora global database.

" + "smithy.api#documentation": "

Contains the state of scheduled or in-process failover operations on an\n Aurora global database (GlobalCluster). This Data type is empty unless a failover\n operation is scheduled or is currently underway on the Aurora global database.

" } }, "com.amazonaws.rds#FailoverStatus": { @@ -12463,7 +12460,7 @@ } }, "traits": { - "smithy.api#documentation": "

A filter name and value pair that is used to return a more specific list of results \n from a describe operation. Filters can be used to match a set of resources by specific \n criteria, such as IDs. The filters supported by a describe operation are documented \n with the describe operation.

\n \n

Currently, wildcards are not supported in filters.

\n \n

The following actions can be filtered:

\n " + "smithy.api#documentation": "

A filter name and value pair that is used to return a more specific list of results \n from a describe operation. Filters can be used to match a set of resources by specific \n criteria, such as IDs. The filters supported by a describe operation are documented \n with the describe operation.

\n \n

Currently, wildcards are not supported in filters.

\n \n

The following actions can be filtered:

\n " } }, "com.amazonaws.rds#FilterList": { @@ -12490,13 +12487,13 @@ "GlobalClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n Contains a user-supplied global database cluster identifier. This identifier is the unique key that\n identifies a global database cluster.\n

" + "smithy.api#documentation": "

Contains a user-supplied global database cluster identifier. This identifier is the unique key that\n identifies a global database cluster.

" } }, "GlobalClusterResourceId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in\n Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB cluster is accessed.\n

" + "smithy.api#documentation": "

The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in\n Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB cluster is accessed.

" } }, "GlobalClusterArn": { @@ -12514,7 +12511,7 @@ "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n The Aurora database engine used by the global database cluster.\n

" + "smithy.api#documentation": "

The Aurora database engine used by the global database cluster.

" } }, "EngineVersion": { @@ -12526,31 +12523,31 @@ "DatabaseName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n The default database name within the new global database cluster.\n

" + "smithy.api#documentation": "

The default database name within the new global database cluster.

" } }, "StorageEncrypted": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

\n The storage encryption setting for the global database cluster.\n

" + "smithy.api#documentation": "

The storage encryption setting for the global database cluster.

" } }, "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

\n The deletion protection setting for the new global database cluster.\n

" + "smithy.api#documentation": "

The deletion protection setting for the new global database cluster.

" } }, "GlobalClusterMembers": { "target": "com.amazonaws.rds#GlobalClusterMemberList", "traits": { - "smithy.api#documentation": "

\n The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to\n 1 item.\n

" + "smithy.api#documentation": "

The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to\n 1 item.

" } }, "FailoverState": { "target": "com.amazonaws.rds#FailoverState", "traits": { - "smithy.api#documentation": "

A data object containing all properties for the current state of an in-process or pending failover process for this Aurora global database.\n This object is empty unless the FailoverGlobalCluster API operation has been called on this Aurora global database (GlobalCluster).\n

" + "smithy.api#documentation": "

A data object containing all properties for the current state of an in-process or pending failover process for this Aurora global database.\n This object is empty unless the FailoverGlobalCluster API operation has been called on this Aurora global database (GlobalCluster).

" } } }, @@ -12600,19 +12597,19 @@ "DBClusterArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) for each Aurora cluster.\n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for each Aurora cluster.

" } }, "Readers": { "target": "com.amazonaws.rds#ReadersArnList", "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) for each read-only secondary cluster\n associated with the Aurora global database.\n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for each read-only secondary cluster\n associated with the Aurora global database.

" } }, "IsWriter": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

\n Specifies whether the Aurora cluster is the primary cluster\n (that is, has read-write capability) for the Aurora global\n database with which it is associated.\n

" + "smithy.api#documentation": "

Specifies whether the Aurora cluster is the primary cluster\n (that is, has read-write capability) for the Aurora global\n database with which it is associated.

" } }, "GlobalWriteForwardingStatus": { @@ -12623,7 +12620,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n A data structure with information about any primary and\n secondary clusters associated with an Aurora global database.\n

" + "smithy.api#documentation": "

A data structure with information about any primary and\n secondary clusters associated with an Aurora global database.

" } }, "com.amazonaws.rds#GlobalClusterMemberList": { @@ -12647,7 +12644,7 @@ "code": "GlobalClusterNotFoundFault", "httpResponseCode": 404 }, - "smithy.api#documentation": "

The GlobalClusterIdentifier doesn't refer to an existing global database cluster.

", + "smithy.api#documentation": "

The GlobalClusterIdentifier doesn't refer to an existing global database cluster.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -12675,13 +12672,13 @@ "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous DescribeGlobalClusters request.\n If this parameter is specified, the response includes\n only records beyond the marker, up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeGlobalClusters request.\n If this parameter is specified, the response includes\n only records beyond the marker, up to the value specified by MaxRecords.

" } }, "GlobalClusters": { "target": "com.amazonaws.rds#GlobalClusterList", "traits": { - "smithy.api#documentation": "

\n The list of global clusters returned by this request.\n

" + "smithy.api#documentation": "

The list of global clusters returned by this request.

" } } } @@ -12718,7 +12715,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n This data type is used as a response element in the DescribeDBSecurityGroups action.\n

" + "smithy.api#documentation": "

This data type is used as a response element in the DescribeDBSecurityGroups action.

" } }, "com.amazonaws.rds#IPRangeList": { @@ -12797,21 +12794,21 @@ "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the database engine to be used for this instance.\n

\n \n

The list only includes supported DB engines that require an on-premises \n customer provided license.\n

\n \n

Valid Values:\n

\n ", + "smithy.api#documentation": "

The name of the database engine to be used for this instance.

\n

The list only includes supported DB engines that require an on-premises \n customer provided license.

\n

Valid Values:

\n ", "smithy.api#required": {} } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The version number of the database engine to use.

\n

For a list of valid engine versions, call DescribeDBEngineVersions.

\n

The following are the database engines and links to information about the major and minor \n versions. The list only includes DB engines that require an on-premises \n customer provided license.

\n \n

\n Microsoft SQL Server\n

\n \n

See \n Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide.\n

", + "smithy.api#documentation": "

The version number of the database engine to use.

\n

For a list of valid engine versions, call DescribeDBEngineVersions.

\n

The following are the database engines and links to information about the major and minor \n versions. The list only includes DB engines that require an on-premises \n customer provided license.

\n

\n Microsoft SQL Server\n

\n

See \n Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide.

", "smithy.api#required": {} } }, "EngineInstallationMediaPath": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The path to the installation medium for the specified DB engine.

\n

Example: SQLServerISO/en_sql_server_2016_enterprise_x64_dvd_8701793.iso\n

", + "smithy.api#documentation": "

The path to the installation medium for the specified DB engine.

\n

Example: SQLServerISO/en_sql_server_2016_enterprise_x64_dvd_8701793.iso\n

", "smithy.api#required": {} } }, @@ -13145,7 +13142,7 @@ "code": "InvalidDBInstanceAutomatedBackupState", "httpResponseCode": 400 }, - "smithy.api#documentation": "

The automated backup is in an invalid state. \n \t For example, this automated backup is associated with an active instance.

", + "smithy.api#documentation": "

The automated backup is in an invalid state. \n For example, this automated backup is associated with an active instance.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -13298,7 +13295,7 @@ "code": "InvalidDBSubnetStateFault", "httpResponseCode": 400 }, - "smithy.api#documentation": "

\n The DB subnet isn't in the available state.\n

", + "smithy.api#documentation": "

The DB subnet isn't in the available state.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -13383,7 +13380,7 @@ "code": "InvalidGlobalClusterStateFault", "httpResponseCode": 400 }, - "smithy.api#documentation": "

The global cluster is in an invalid state and can't perform the requested operation.

", + "smithy.api#documentation": "

The global cluster is in an invalid state and can't perform the requested operation.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -13400,7 +13397,7 @@ "code": "InvalidOptionGroupStateFault", "httpResponseCode": 400 }, - "smithy.api#documentation": "

\n The option group isn't in the available state.\n

", + "smithy.api#documentation": "

The option group isn't in the available state.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -13532,7 +13529,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all tags on an Amazon RDS resource.

\n

For an overview on tagging an Amazon RDS resource, \n see Tagging Amazon RDS Resources \n in the Amazon RDS User Guide.

" + "smithy.api#documentation": "

Lists all tags on an Amazon RDS resource.

\n

For an overview on tagging an Amazon RDS resource, \n see Tagging Amazon RDS Resources \n in the Amazon RDS User Guide.

" } }, "com.amazonaws.rds#ListTagsForResourceMessage": { @@ -13624,7 +13621,7 @@ } ], "traits": { - "smithy.api#documentation": "

Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS)\n certificate for Amazon RDS for new DB instances temporarily, or remove the override.

\n

By using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB\n instances that is different from the default certificate provided by RDS. You can also\n use this operation to remove the override, so that new DB instances use the default\n certificate provided by RDS.

\n

You might need to override the default certificate in the following situations:

\n \n

For more information about rotating your SSL/TLS certificate for RDS DB engines, see \n \n Rotating Your SSL/TLS Certificate in the Amazon RDS User Guide.

\n

For more information about rotating your SSL/TLS certificate for Aurora DB engines, see \n \n Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.

" + "smithy.api#documentation": "

Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS)\n certificate for Amazon RDS for new DB instances temporarily, or remove the override.

\n

By using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB\n instances that is different from the default certificate provided by RDS. You can also\n use this operation to remove the override, so that new DB instances use the default\n certificate provided by RDS.

\n

You might need to override the default certificate in the following situations:

\n \n

For more information about rotating your SSL/TLS certificate for RDS DB engines, see \n \n Rotating Your SSL/TLS Certificate in the Amazon RDS User Guide.

\n

For more information about rotating your SSL/TLS certificate for Aurora DB engines, see \n \n Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.

" } }, "com.amazonaws.rds#ModifyCertificatesMessage": { @@ -13633,7 +13630,7 @@ "CertificateIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The new default certificate identifier to override the current one with.

\n

To determine the valid values, use the describe-certificates CLI\n command or the DescribeCertificates API operation.

" + "smithy.api#documentation": "

The new default certificate identifier to override the current one with.

\n

To determine the valid values, use the describe-certificates CLI\n command or the DescribeCertificates API operation.

" } }, "RemoveCustomerOverride": { @@ -13672,7 +13669,7 @@ } ], "traits": { - "smithy.api#documentation": "

Set the capacity of an Aurora Serverless DB cluster to a specific value.

\n

Aurora Serverless scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale \n fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity \n to set the capacity explicitly.

\n

After this call sets the DB cluster capacity, Aurora Serverless can automatically scale\n the DB cluster based on the cooldown period for scaling up and the cooldown period\n for scaling down.

\n

For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the \n Amazon Aurora User Guide.

\n \n

If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that \n prevent Aurora Serverless from finding a scaling point might be dropped. For more information about scaling points, \n see \n Autoscaling for Aurora Serverless in the Amazon Aurora User Guide.

\n \n \n

This action only applies to Aurora Serverless DB clusters.

\n " + "smithy.api#documentation": "

Set the capacity of an Aurora Serverless v1 DB cluster to a specific value.

\n

Aurora Serverless v1 scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale \n fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity \n to set the capacity explicitly.

\n

After this call sets the DB cluster capacity, Aurora Serverless v1 can automatically scale\n the DB cluster based on the cooldown period for scaling up and the cooldown period\n for scaling down.

\n

For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the \n Amazon Aurora User Guide.

\n \n

If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that \n prevent Aurora Serverless v1 from finding a scaling point might be dropped. For more information about scaling points, \n see \n Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.

\n \n \n

This action only applies to Aurora Serverless v1 DB clusters.

\n " } }, "com.amazonaws.rds#ModifyCurrentDBClusterCapacityMessage": { @@ -13688,13 +13685,13 @@ "Capacity": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The DB cluster capacity.

\n

When you change the capacity of a paused Aurora Serverless DB cluster, it automatically resumes.

\n

Constraints:

\n " + "smithy.api#documentation": "

The DB cluster capacity.

\n

When you change the capacity of a paused Aurora Serverless v1 DB cluster, it automatically resumes.

\n

Constraints:

\n " } }, "SecondsBeforeTimeout": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, that Aurora Serverless tries to find a scaling point\n to perform seamless scaling before enforcing the timeout action. The default is\n 300.

\n

Specify a value between 10 and 600 seconds.

" + "smithy.api#documentation": "

The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point\n to perform seamless scaling before enforcing the timeout action. The default is\n 300.

\n

Specify a value between 10 and 600 seconds.

" } }, "TimeoutAction": { @@ -13722,7 +13719,7 @@ } ], "traits": { - "smithy.api#documentation": "

Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling \n DescribeDBEngineVersions.

\n \n

The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with \n Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the \n ModifyCustomDbEngineVersion event aren't logged. However, you might see calls from the \n API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for \n the ModifyCustomDbEngineVersion event.

\n \n

For more information, see Modifying CEV status \n in the Amazon RDS User Guide.

" + "smithy.api#documentation": "

Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling \n DescribeDBEngineVersions.

\n \n

The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with \n Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the \n ModifyCustomDbEngineVersion event aren't logged. However, you might see calls from the \n API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for \n the ModifyCustomDbEngineVersion event.

\n \n

For more information, see Modifying CEV status \n in the Amazon RDS User Guide.

" } }, "com.amazonaws.rds#ModifyCustomDBEngineVersionMessage": { @@ -13751,7 +13748,7 @@ "Status": { "target": "com.amazonaws.rds#CustomEngineVersionStatus", "traits": { - "smithy.api#documentation": "

The availability status to be assigned to the CEV. Valid values are as follows:

\n
\n
available
\n
\n

You can use this CEV to create a new RDS Custom DB instance.

\n
\n
inactive
\n
\n

You can create a new RDS Custom instance by restoring a DB snapshot with this CEV. \n You can't patch or create new instances with this CEV.

\n
\n
\n

You can change any status to any status. A typical reason to change status is to prevent the accidental \n use of a CEV, or to make a deprecated CEV eligible for use again. For example, you might change the status \n of your CEV from available to inactive, and from inactive back to \n available. To change the availability status of the CEV, it must not currently be in use by an \n RDS Custom instance, snapshot, or automated backup.\n

" + "smithy.api#documentation": "

The availability status to be assigned to the CEV. Valid values are as follows:

\n
\n
available
\n
\n

You can use this CEV to create a new RDS Custom DB instance.

\n
\n
inactive
\n
\n

You can create a new RDS Custom instance by restoring a DB snapshot with this CEV. \n You can't patch or create new instances with this CEV.

\n
\n
\n

You can change any status to any status. A typical reason to change status is to prevent the accidental \n use of a CEV, or to make a deprecated CEV eligible for use again. For example, you might change the status \n of your CEV from available to inactive, and from inactive back to \n available. To change the availability status of the CEV, it must not currently be in use by an \n RDS Custom instance, snapshot, or automated backup.

" } } } @@ -13803,7 +13800,7 @@ } ], "traits": { - "smithy.api#documentation": "

Modify the settings for an Amazon Aurora DB cluster or a Multi-AZ DB cluster. \n You can change one or more settings by specifying these parameters and the new values in the\n request.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

Modify the settings for an Amazon Aurora DB cluster or a Multi-AZ DB cluster. \n You can change one or more settings by specifying these parameters and the new values in the\n request.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

" } }, "com.amazonaws.rds#ModifyDBClusterEndpoint": { @@ -13832,7 +13829,7 @@ } ], "traits": { - "smithy.api#documentation": "

Modifies the properties of an endpoint in an Amazon Aurora DB cluster.

\n \n

This action only applies to Aurora DB clusters.

\n " + "smithy.api#documentation": "

Modifies the properties of an endpoint in an Amazon Aurora DB cluster.

\n \n

This action only applies to Aurora DB clusters.

\n " } }, "com.amazonaws.rds#ModifyDBClusterEndpointMessage": { @@ -13871,86 +13868,86 @@ "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.

\n

Constraints: This identifier must match the identifier of an existing DB\n cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", + "smithy.api#documentation": "

The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.

\n

Constraints: This identifier must match the identifier of an existing DB\n cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", "smithy.api#required": {} } }, "NewDBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.

\n

Constraints:

\n \n

Example: my-cluster2\n

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.

\n

Constraints:

\n \n

Example: my-cluster2\n

\n

Valid for: Aurora DB clusters only

" } }, "ApplyImmediately": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

A value that indicates whether the modifications in this request and\n any pending modifications are asynchronously applied\n as soon as possible, regardless of the\n PreferredMaintenanceWindow setting for the DB cluster. \n If this parameter is disabled, changes to the\n DB cluster are applied during the next maintenance window.

\n

The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication, \n MasterUserPassword, and NewDBClusterIdentifier values. If the ApplyImmediately \n parameter is disabled, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, \n and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are\n applied immediately, regardless of the value of the ApplyImmediately parameter.

\n

By default, this parameter is disabled.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

A value that indicates whether the modifications in this request and\n any pending modifications are asynchronously applied\n as soon as possible, regardless of the\n PreferredMaintenanceWindow setting for the DB cluster. \n If this parameter is disabled, changes to the\n DB cluster are applied during the next maintenance window.

\n

The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication, \n MasterUserPassword, and NewDBClusterIdentifier values. If the ApplyImmediately \n parameter is disabled, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, \n and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are\n applied immediately, regardless of the value of the ApplyImmediately parameter.

\n

By default, this parameter is disabled.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "BackupRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of days for which automated backups are retained. Specify a minimum value of 1.

\n

Default: 1

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The number of days for which automated backups are retained. Specify a minimum value of 1.

\n

Default: 1

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "DBClusterParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the DB cluster parameter group to use for the DB cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The name of the DB cluster parameter group to use for the DB cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "VpcSecurityGroupIds": { "target": "com.amazonaws.rds#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "

A list of VPC security groups that the DB cluster will belong to.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

A list of VPC security groups that the DB cluster will belong to.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "Port": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The port number on which the DB cluster accepts connections.

\n

Constraints: Value must be 1150-65535\n

\n

Default: The same port as the original DB cluster.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

The port number on which the DB cluster accepts connections.

\n

Constraints: Value must be 1150-65535\n

\n

Default: The same port as the original DB cluster.

\n

Valid for: Aurora DB clusters only

" } }, "MasterUserPassword": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The new password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

\n

Constraints: Must contain from 8 to 41 characters.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The new password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

\n

Constraints: Must contain from 8 to 41 characters.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

A value that indicates that the DB cluster should be associated with the specified option group.

\n

DB clusters are associated with a default option group that can't be modified.

" + "smithy.api#documentation": "

A value that indicates that the DB cluster should be associated with the specified option group.

\n

DB clusters are associated with a default option group that can't be modified.

" } }, "PreferredBackupWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.\n

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.\n

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "PreferredMaintenanceWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.\n

\n

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

\n

Constraints: Minimum 30-minute window.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

\n

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

\n

Constraints: Minimum 30-minute window.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.\n

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" } }, "BacktrackWindow": { "target": "com.amazonaws.rds#LongOptional", "traits": { - "smithy.api#documentation": "

The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

\n

Default: 0

\n

Constraints:

\n \n

Valid for: Aurora MySQL DB clusters only

" + "smithy.api#documentation": "

The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

\n

Default: 0

\n

Constraints:

\n \n

Valid for: Aurora MySQL DB clusters only

" } }, "CloudwatchLogsExportConfiguration": { "target": "com.amazonaws.rds#CloudwatchLogsExportConfiguration", "traits": { - "smithy.api#documentation": "

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster. The values\n in the list depend on the DB engine being used.

\n

\n RDS for MySQL\n

\n

Possible values are error, general, and slowquery.

\n

\n RDS for PostgreSQL\n

\n

Possible values are postgresql and upgrade.

\n

\n Aurora MySQL\n

\n

Possible values are audit, error, general, and slowquery.

\n

\n Aurora PostgreSQL\n

\n

Possible value is postgresql.

\n

For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database\n Service User Guide.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster. The values\n in the list depend on the DB engine being used.

\n

\n RDS for MySQL\n

\n

Possible values are error, general, and slowquery.

\n

\n RDS for PostgreSQL\n

\n

Possible values are postgresql and upgrade.

\n

\n Aurora MySQL\n

\n

Possible values are audit, error, general, and slowquery.

\n

\n Aurora PostgreSQL\n

\n

Possible value is postgresql.

\n

For more information about exporting CloudWatch Logs for Amazon RDS, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "EngineVersion": { @@ -13962,19 +13959,19 @@ "AllowMajorVersionUpgrade": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

A value that indicates whether major version upgrades are allowed.

\n

Constraints: You must allow major version upgrades when specifying a value for the\n EngineVersion parameter that is a different major version than the DB\n cluster's current version.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

A value that indicates whether major version upgrades are allowed.

\n

Constraints: You must allow major version upgrades when specifying a value for the\n EngineVersion parameter that is a different major version than the DB\n cluster's current version.

\n

Valid for: Aurora DB clusters only

" } }, "DBInstanceParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the DB parameter group to apply to all instances of the DB cluster.

\n \n

When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB\n cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than \n during the next maintenance window.

\n \n

Default: The existing name setting

\n

Constraints:

\n \n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

The name of the DB parameter group to apply to all instances of the DB cluster.

\n \n

When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB\n cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than \n during the next maintenance window.

\n \n

Default: The existing name setting

\n

Constraints:

\n \n

Valid for: Aurora DB clusters only

" } }, "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Active Directory directory ID to move the DB cluster to. \n Specify none to remove the cluster from its current domain.\n The domain must be created prior to this operation.\n

\n

For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.\n

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

The Active Directory directory ID to move the DB cluster to. \n Specify none to remove the cluster from its current domain.\n The domain must be created prior to this operation.

\n

For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" } }, "DomainIAMRoleName": { @@ -13992,13 +13989,13 @@ "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "EnableHttpEndpoint": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint \n is disabled.

\n

When enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless DB cluster. You can also query your database\n from inside the RDS console with the query editor.

\n

For more information, see Using the Data API for Aurora Serverless in the \n Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint \n is disabled.

\n

When enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database\n from inside the RDS console with the query editor.

\n

For more information, see Using the Data API for Aurora Serverless v1 in the \n Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" } }, "CopyTagsToSnapshot": { @@ -14010,31 +14007,31 @@ "EnableGlobalWriteForwarding": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an\n Aurora global database (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that\n are secondary clusters in an Aurora global database.

\n

You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter\n enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to\n this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is\n demoted by the FailoverGlobalCluster API operation, but it does nothing until then.\n

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an\n Aurora global database (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that\n are secondary clusters in an Aurora global database.

\n

You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter\n enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to\n this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is\n demoted by the FailoverGlobalCluster API operation, but it does nothing until then.

\n

Valid for: Aurora DB clusters only

" } }, "DBClusterInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

\n

For the full list of DB instance classes and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.\n

\n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

\n

For the full list of DB instance classes and availability for your engine, see \n DB Instance Class in the Amazon RDS User Guide.

\n

Valid for: Multi-AZ DB clusters only

" } }, "AllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

\n

Type: Integer

\n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

\n

Type: Integer

\n

Valid for: Multi-AZ DB clusters only

" } }, "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the DB cluster.

\n

\n Valid values: io1\n

\n

\n When specified, a value for the Iops parameter is required.\n

\n

\n Default: io1\n

\n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

Specifies the storage type to be associated with the DB cluster.

\n

Valid values: io1\n

\n

When specified, a value for the Iops parameter is required.

\n

Default: io1\n

\n

Valid for: Multi-AZ DB clusters only

" } }, "Iops": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated \n for each DB instance in the Multi-AZ DB cluster.

\n

For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.\n

\n

Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.

\n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated \n for each DB instance in the Multi-AZ DB cluster.

\n

For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.

\n

Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.

\n

Valid for: Multi-AZ DB clusters only

" } }, "AutoMinorVersionUpgrade": { @@ -14046,7 +14043,7 @@ "MonitoringInterval": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. \n To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0.

\n

If MonitoringRoleArn is specified, also set MonitoringInterval\n to a value other than 0.

\n

Valid Values: 0, 1, 5, 10, 15, 30, 60\n

\n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. \n To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0.

\n

If MonitoringRoleArn is specified, also set MonitoringInterval\n to a value other than 0.

\n

Valid Values: 0, 1, 5, 10, 15, 30, 60\n

\n

Valid for: Multi-AZ DB clusters only

" } }, "MonitoringRoleArn": { @@ -14058,7 +14055,7 @@ "EnablePerformanceInsights": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to turn on Performance Insights for the DB cluster.

\n

For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.\n

\n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

A value that indicates whether to turn on Performance Insights for the DB cluster.

\n

For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.

\n

Valid for: Multi-AZ DB clusters only

" } }, "PerformanceInsightsKMSKeyId": { @@ -14095,7 +14092,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Modifies the parameters of a DB cluster parameter group. To modify more than one parameter,\n submit a list of the following: ParameterName, ParameterValue, \n and ApplyMethod. A maximum of 20\n parameters can be modified in a single request.\n

\n \n

After you create a DB cluster parameter group, you should wait at least 5 minutes\n before creating your first DB cluster that uses that DB cluster parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the create action before the parameter \n group is used as the default for a new DB cluster. This is especially important for parameters \n that are critical when creating the default database for a DB cluster, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBClusterParameters action to verify \n that your DB cluster parameter group has been created or modified.

\n

If the modified DB cluster parameter group is used by an Aurora Serverless cluster, Aurora\n applies the update immediately. The cluster restart might interrupt your workload. In that case,\n your application must reopen any connections and retry any transactions that were active\n when the parameter changes took effect.

\n \n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

Modifies the parameters of a DB cluster parameter group. To modify more than one parameter,\n submit a list of the following: ParameterName, ParameterValue, \n and ApplyMethod. A maximum of 20\n parameters can be modified in a single request.

\n \n

After you create a DB cluster parameter group, you should wait at least 5 minutes\n before creating your first DB cluster that uses that DB cluster parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the create action before the parameter \n group is used as the default for a new DB cluster. This is especially important for parameters \n that are critical when creating the default database for a DB cluster, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBClusterParameters action to verify \n that your DB cluster parameter group has been created or modified.

\n

If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora\n applies the update immediately. The cluster restart might interrupt your workload. In that case,\n your application must reopen any connections and retry any transactions that were active\n when the parameter changes took effect.

\n \n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" } }, "com.amazonaws.rds#ModifyDBClusterParameterGroupMessage": { @@ -14111,7 +14108,7 @@ "Parameters": { "target": "com.amazonaws.rds#ParametersList", "traits": { - "smithy.api#documentation": "

A list of parameters in the DB cluster parameter group to modify.

\n

Valid Values (for the application method): immediate | pending-reboot\n

\n \n

You can use the immediate value with dynamic parameters only. You can use the \n pending-reboot value for both dynamic and static parameters.

\n

When the application method is immediate, changes to dynamic parameters are applied immediately \n to the DB clusters associated with the parameter group. When the application method is pending-reboot, \n changes to dynamic and static parameters are applied after a reboot without failover to the DB clusters associated with the \n parameter group.

\n ", + "smithy.api#documentation": "

A list of parameters in the DB cluster parameter group to modify.

\n

Valid Values (for the application method): immediate | pending-reboot\n

\n \n

You can use the immediate value with dynamic parameters only. You can use the \n pending-reboot value for both dynamic and static parameters.

\n

When the application method is immediate, changes to dynamic parameters are applied immediately \n to the DB clusters associated with the parameter group. When the application method is pending-reboot, \n changes to dynamic and static parameters are applied after a reboot without failover to the DB clusters associated with the \n parameter group.

\n ", "smithy.api#required": {} } } @@ -14261,7 +14258,7 @@ } ], "traits": { - "smithy.api#documentation": "

Modifies settings for a DB instance. \n You can change one or more database configuration parameters by specifying these parameters and the new values in the request.\n To learn what modifications you can make to your DB instance,\n call DescribeValidDBInstanceModifications\n before you call ModifyDBInstance.\n

" + "smithy.api#documentation": "

Modifies settings for a DB instance. \n You can change one or more database configuration parameters by specifying these parameters and the new values in the request.\n To learn what modifications you can make to your DB instance,\n call DescribeValidDBInstanceModifications\n before you call ModifyDBInstance.

" } }, "com.amazonaws.rds#ModifyDBInstanceMessage": { @@ -14270,98 +14267,98 @@ "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The DB instance identifier. This value is stored as a lowercase string.

\n

Constraints:

\n ", + "smithy.api#documentation": "

The DB instance identifier. This value is stored as a lowercase string.

\n

Constraints:

\n ", "smithy.api#required": {} } }, "AllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The new amount of storage in gibibytes (GiB) to allocate for the DB instance.\n

\n \n

For MariaDB, MySQL, Oracle, and PostgreSQL, \n the value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up \n so that they are 10% greater than the current value.\n

\n \n

For the valid values for allocated storage for each engine,\n see CreateDBInstance.\n

" + "smithy.api#documentation": "

The new amount of storage in gibibytes (GiB) to allocate for the DB instance.

\n

For MariaDB, MySQL, Oracle, and PostgreSQL, \n the value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up \n so that they are 10% greater than the current value.

\n

For the valid values for allocated storage for each engine,\n see CreateDBInstance.

" } }, "DBInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The new compute and memory capacity of the DB instance, for example db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n

\n

If you modify the DB instance class, an outage occurs during the change.\n The change is applied during the next maintenance window,\n unless ApplyImmediately is enabled for this request.\n

\n

This setting doesn't apply to RDS Custom for Oracle.

\n

Default: Uses existing setting

" + "smithy.api#documentation": "

The new compute and memory capacity of the DB instance, for example db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.

\n

If you modify the DB instance class, an outage occurs during the change.\n The change is applied during the next maintenance window,\n unless ApplyImmediately is enabled for this request.

\n

This setting doesn't apply to RDS Custom for Oracle.

\n

Default: Uses existing setting

" } }, "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The new DB subnet group for the DB instance.\n You can use this parameter to move your DB instance to a different VPC.\n \n If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC.\n For more information, see \n Working with a DB instance in a VPC \n in the Amazon RDS User Guide.\n

\n

Changing the subnet group causes an outage during the change. \n The change is applied during the next maintenance window,\n unless you enable ApplyImmediately.

\n

This parameter doesn't apply to RDS Custom.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mydbsubnetgroup\n

" + "smithy.api#documentation": "

The new DB subnet group for the DB instance.\n You can use this parameter to move your DB instance to a different VPC.\n \n \n If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC.\n For more information, see \n Working with a DB instance in a VPC \n in the Amazon RDS User Guide.

\n

Changing the subnet group causes an outage during the change. \n The change is applied during the next maintenance window,\n unless you enable ApplyImmediately.

\n

This parameter doesn't apply to RDS Custom.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mydbsubnetgroup\n

" } }, "DBSecurityGroups": { "target": "com.amazonaws.rds#DBSecurityGroupNameList", "traits": { - "smithy.api#documentation": "

A list of DB security groups to authorize on this DB instance. Changing this setting doesn't \n result in an outage and the change is asynchronously applied as soon as possible.

\n

This setting doesn't apply to RDS Custom.

\n

Constraints:

\n " + "smithy.api#documentation": "

A list of DB security groups to authorize on this DB instance. Changing this setting doesn't \n result in an outage and the change is asynchronously applied as soon as possible.

\n

This setting doesn't apply to RDS Custom.

\n

Constraints:

\n " } }, "VpcSecurityGroupIds": { "target": "com.amazonaws.rds#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "

A list of Amazon EC2 VPC security groups to authorize on this DB instance. This change is \n asynchronously applied as soon as possible.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable. The associated list of EC2 VPC security groups is managed by\n the DB cluster. For more information, see ModifyDBCluster.

\n

Constraints:

\n " + "smithy.api#documentation": "

A list of Amazon EC2 VPC security groups to authorize on this DB instance. This change is \n asynchronously applied as soon as possible.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable. The associated list of EC2 VPC security groups is managed by\n the DB cluster. For more information, see ModifyDBCluster.

\n

Constraints:

\n " } }, "ApplyImmediately": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, \n regardless of the PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is disabled.

\n

\n If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage\n and are applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in \n Modifying a DB Instance in the \n Amazon RDS User Guide to see the impact of enabling or disabling ApplyImmediately for each modified parameter and to \n determine when the changes are applied.\n

" + "smithy.api#documentation": "

A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, \n regardless of the PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is disabled.

\n

If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage\n and are applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in \n Modifying a DB Instance in the \n Amazon RDS User Guide to see the impact of enabling or disabling ApplyImmediately for each modified parameter and to \n determine when the changes are applied.

" } }, "MasterUserPassword": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The new password for the master user. The password can include any printable ASCII \n character except \"/\", \"\"\", or \"@\".

\n

\n Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. \n Between the time of the request and the completion of the request,\n the MasterUserPassword element exists in the\n PendingModifiedValues element of the operation response.\n

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable. The password for the master user is managed by the DB cluster. For\n more information, see ModifyDBCluster.\n

\n \n

Default: Uses existing setting

\n\n

\n MariaDB\n

\n

Constraints: Must contain from 8 to 41 characters.

\n \n

\n Microsoft SQL Server\n

\n

Constraints: Must contain from 8 to 128 characters.

\n \n

\n MySQL\n

\n

Constraints: Must contain from 8 to 41 characters.

\n \n

\n Oracle\n

\n

Constraints: Must contain from 8 to 30 characters.

\n \n

\n PostgreSQL\n

\n

Constraints: Must contain from 8 to 128 characters.

\n\n \n

Amazon RDS API actions never return the password, \n so this action provides a way to regain access to a primary instance user if the password is lost. \n This includes restoring privileges that might have been accidentally revoked.\n

\n " + "smithy.api#documentation": "

The new password for the master user. The password can include any printable ASCII \n character except \"/\", \"\"\", or \"@\".

\n

Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. \n Between the time of the request and the completion of the request,\n the MasterUserPassword element exists in the\n PendingModifiedValues element of the operation response.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable. The password for the master user is managed by the DB cluster. For\n more information, see ModifyDBCluster.

\n

Default: Uses existing setting

\n

\n MariaDB\n

\n

Constraints: Must contain from 8 to 41 characters.

\n

\n Microsoft SQL Server\n

\n

Constraints: Must contain from 8 to 128 characters.

\n

\n MySQL\n

\n

Constraints: Must contain from 8 to 41 characters.

\n

\n Oracle\n

\n

Constraints: Must contain from 8 to 30 characters.

\n

\n PostgreSQL\n

\n

Constraints: Must contain from 8 to 128 characters.

\n \n

Amazon RDS API actions never return the password, \n so this action provides a way to regain access to a primary instance user if the password is lost. \n This includes restoring privileges that might have been accidentally revoked.

\n " } }, "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the DB parameter group to apply to the DB instance.

\n

Changing this setting doesn't result in an outage. The parameter group name itself is changed\n immediately, but the actual parameter changes are not applied until you reboot the\n instance without failover. In this case, the DB instance isn't rebooted automatically, and the\n parameter changes aren't applied during the next maintenance window. However, if you modify \n dynamic parameters in the newly associated DB parameter group, these changes are applied \n immediately without a reboot.

\n

This setting doesn't apply to RDS Custom.

\n

Default: Uses existing setting

\n

Constraints: The DB parameter group must be in the same DB parameter group family as the DB instance.

" + "smithy.api#documentation": "

The name of the DB parameter group to apply to the DB instance.

\n

Changing this setting doesn't result in an outage. The parameter group name itself is changed\n immediately, but the actual parameter changes are not applied until you reboot the\n instance without failover. In this case, the DB instance isn't rebooted automatically, and the\n parameter changes aren't applied during the next maintenance window. However, if you modify \n dynamic parameters in the newly associated DB parameter group, these changes are applied \n immediately without a reboot.

\n

This setting doesn't apply to RDS Custom.

\n

Default: Uses existing setting

\n

Constraints: The DB parameter group must be in the same DB parameter group family as the DB instance.

" } }, "BackupRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

\n \n

Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.

\n \n

These changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled\n for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously\n applied as soon as possible.

\n

\n Amazon Aurora\n

\n

Not applicable. The retention period for automated backups is managed by the DB\n cluster. For more information, see ModifyDBCluster.

\n

Default: Uses existing setting

\n

Constraints:

\n " + "smithy.api#documentation": "

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

\n \n

Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.

\n \n

These changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled\n for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously\n applied as soon as possible.

\n

\n Amazon Aurora\n

\n

Not applicable. The retention period for automated backups is managed by the DB\n cluster. For more information, see ModifyDBCluster.

\n

Default: Uses existing setting

\n

Constraints:

\n " } }, "PreferredBackupWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n The daily time range during which automated backups are created\n if automated backups are enabled,\n as determined by the BackupRetentionPeriod parameter. \n Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. \n The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.\n

\n \n

\n Amazon Aurora\n

\n

Not applicable. The daily time range for creating automated backups is managed by\n the DB cluster. For more information, see ModifyDBCluster.

\n \n

Constraints:

\n " + "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled,\n as determined by the BackupRetentionPeriod parameter. \n Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. \n The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.\n

\n

\n Amazon Aurora\n

\n

Not applicable. The daily time range for creating automated backups is managed by\n the DB cluster. For more information, see ModifyDBCluster.

\n

Constraints:

\n " } }, "PreferredMaintenanceWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The weekly time range (in UTC) during which system maintenance can occur, which\n might result in an outage. Changing this parameter doesn't result in an outage, except\n in the following situation, and the change is asynchronously applied as soon as\n possible. If there are pending actions that cause a reboot, and the maintenance window\n is changed to include the current time, then changing this parameter will cause a reboot\n of the DB instance. If moving this window to the current time, there must be at least 30\n minutes between the current time and end of the window to ensure pending changes are\n applied.

\n

For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.\n

\n

Default: Uses existing setting

\n

Format: ddd:hh24:mi-ddd:hh24:mi

\n

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

\n

Constraints: Must be at least 30 minutes

" + "smithy.api#documentation": "

The weekly time range (in UTC) during which system maintenance can occur, which\n might result in an outage. Changing this parameter doesn't result in an outage, except\n in the following situation, and the change is asynchronously applied as soon as\n possible. If there are pending actions that cause a reboot, and the maintenance window\n is changed to include the current time, then changing this parameter will cause a reboot\n of the DB instance. If moving this window to the current time, there must be at least 30\n minutes between the current time and end of the window to ensure pending changes are\n applied.

\n

For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.\n

\n

Default: Uses existing setting

\n

Format: ddd:hh24:mi-ddd:hh24:mi

\n

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

\n

Constraints: Must be at least 30 minutes

" } }, "MultiAZ": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result \n in an outage. The change is applied during the next maintenance window unless the ApplyImmediately \n parameter is enabled for this request.\n

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

A value that indicates whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result \n in an outage. The change is applied during the next maintenance window unless the ApplyImmediately \n parameter is enabled for this request.

\n

This setting doesn't apply to RDS Custom.

" } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n The version number of the database engine to upgrade to. \n Changing this parameter results in an outage and the change \n is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled for this request.\n

\n

For major version upgrades, if a nondefault DB parameter group is currently in use, a\n new DB parameter group in the DB parameter group family for the new engine version must\n be specified. The new DB parameter group can be the default for that DB parameter group\n family.

\n

If you specify only a major version, Amazon RDS will update the DB instance to the \n default minor version if the current minor version is lower.\n For information about valid engine versions, see CreateDBInstance, \n or call DescribeDBEngineVersions.

\n

In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the \n PATCH_DB_FAILURE lifecycle.\n

" + "smithy.api#documentation": "

The version number of the database engine to upgrade to. \n Changing this parameter results in an outage and the change \n is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled for this request.

\n

For major version upgrades, if a nondefault DB parameter group is currently in use, a\n new DB parameter group in the DB parameter group family for the new engine version must\n be specified. The new DB parameter group can be the default for that DB parameter group\n family.

\n

If you specify only a major version, Amazon RDS will update the DB instance to the \n default minor version if the current minor version is lower.\n For information about valid engine versions, see CreateDBInstance, \n or call DescribeDBEngineVersions.

\n

In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the \n PATCH_DB_FAILURE lifecycle.

" } }, "AllowMajorVersionUpgrade": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't \n result in an outage and the change is asynchronously applied as soon as possible.

\n

This setting doesn't apply to RDS Custom.

\n

Constraints: Major version upgrades must be allowed when specifying a value \n for the EngineVersion parameter that is a different major version than the DB instance's current version.

" + "smithy.api#documentation": "

A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't \n result in an outage and the change is asynchronously applied as soon as possible.

\n

This setting doesn't apply to RDS Custom.

\n

Constraints: Major version upgrades must be allowed when specifying a value \n for the EngineVersion parameter that is a different major version than the DB instance's current version.

" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether minor version upgrades are applied automatically to the DB instance \n during the maintenance window. An outage occurs when all the following conditions are met:

\n \n

If any of the preceding conditions isn't met, RDS applies the change as soon as possible and\n doesn't cause an outage.

\n

For an RDS Custom DB instance, set AutoMinorVersionUpgrade \n to false. Otherwise, the operation returns an error.

" + "smithy.api#documentation": "

A value that indicates whether minor version upgrades are applied automatically to the DB instance \n during the maintenance window. An outage occurs when all the following conditions are met:

\n \n

If any of the preceding conditions isn't met, RDS applies the change as soon as possible and\n doesn't cause an outage.

\n

For an RDS Custom DB instance, set AutoMinorVersionUpgrade \n to false. Otherwise, the operation returns an error.

" } }, "LicenseModel": { @@ -14373,103 +14370,103 @@ "Iops": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The new Provisioned IOPS (I/O operations per second) value for the RDS instance. \n

\n

Changing this setting doesn't result in an outage and\n the change is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled for this request.\n If you are migrating from Provisioned IOPS to standard storage, set this value to 0. \n The DB instance will require a reboot for the change in storage type to take effect.\n

\n

If you choose to migrate your DB instance from using standard storage to using\n Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process\n can take time. The duration of the migration depends on several factors such as database\n load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS\n provisioned (if any), and the number of prior scale storage operations. Typical\n migration times are under 24 hours, but the process can take up to several days in some\n cases. During the migration, the DB instance is available for use, but might experience\n performance degradation. While the migration takes place, nightly backups for the\n instance are suspended. No other Amazon RDS operations can take place for the instance,\n including modifying the instance, rebooting the instance, deleting the instance,\n creating a read replica for the instance, and creating a DB snapshot of the instance.

\n

Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, \n the value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. \n

\n

Default: Uses existing setting

" + "smithy.api#documentation": "

The new Provisioned IOPS (I/O operations per second) value for the RDS instance.

\n

Changing this setting doesn't result in an outage and\n the change is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled for this request.\n If you are migrating from Provisioned IOPS to standard storage, set this value to 0. \n The DB instance will require a reboot for the change in storage type to take effect.

\n

If you choose to migrate your DB instance from using standard storage to using\n Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process\n can take time. The duration of the migration depends on several factors such as database\n load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS\n provisioned (if any), and the number of prior scale storage operations. Typical\n migration times are under 24 hours, but the process can take up to several days in some\n cases. During the migration, the DB instance is available for use, but might experience\n performance degradation. While the migration takes place, nightly backups for the\n instance are suspended. No other Amazon RDS operations can take place for the instance,\n including modifying the instance, rebooting the instance, deleting the instance,\n creating a read replica for the instance, and creating a DB snapshot of the instance.

\n

Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, \n the value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

\n

Default: Uses existing setting

" } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

A value that indicates the DB instance should be associated with the specified option group.

\n

Changing this parameter doesn't result in an outage, with one exception. If the parameter change results \n in an option group that enables OEM, it can cause a brief period, lasting less than a second, during which \n new connections are rejected but existing connections aren't interrupted.

\n

The change is applied during the next maintenance window unless the ApplyImmediately parameter \n is enabled for this request.

\n

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed \n from an option group, and that option group can't be removed from a DB instance after \n it is associated with a DB instance.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

A value that indicates the DB instance should be associated with the specified option group.

\n

Changing this parameter doesn't result in an outage, with one exception. If the parameter change results \n in an option group that enables OEM, it can cause a brief period, lasting less than a second, during which \n new connections are rejected but existing connections aren't interrupted.

\n

The change is applied during the next maintenance window unless the ApplyImmediately parameter \n is enabled for this request.

\n

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed \n from an option group, and that option group can't be removed from a DB instance after \n it is associated with a DB instance.

\n

This setting doesn't apply to RDS Custom.

" } }, "NewDBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance \n identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will occur \n during the next maintenance window if you disable Apply Immediately. This value is stored as a lowercase string. \n

\n

This setting doesn't apply to RDS Custom.

\n

Constraints:

\n \n

Example: mydbinstance\n

" + "smithy.api#documentation": "

The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance \n identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will occur \n during the next maintenance window if you disable Apply Immediately. This value is stored as a lowercase string.

\n

This setting doesn't apply to RDS Custom.

\n

Constraints:

\n \n

Example: mydbinstance\n

" } }, "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.\n

\n

If you specify Provisioned IOPS (io1), \n you must also include a value for the Iops parameter.\n

\n

If you choose to migrate your DB instance from using standard storage to using\n Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process\n can take time. The duration of the migration depends on several factors such as database\n load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS\n provisioned (if any), and the number of prior scale storage operations. Typical\n migration times are under 24 hours, but the process can take up to several days in some\n cases. During the migration, the DB instance is available for use, but might experience\n performance degradation. While the migration takes place, nightly backups for the\n instance are suspended. No other Amazon RDS operations can take place for the instance,\n including modifying the instance, rebooting the instance, deleting the instance,\n creating a read replica for the instance, and creating a DB snapshot of the instance.

\n

\n Valid values: standard | gp2 | io1\n

\n

Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

" + "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.

\n

If you specify Provisioned IOPS (io1), \n you must also include a value for the Iops parameter.

\n

If you choose to migrate your DB instance from using standard storage to using\n Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process\n can take time. The duration of the migration depends on several factors such as database\n load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS\n provisioned (if any), and the number of prior scale storage operations. Typical\n migration times are under 24 hours, but the process can take up to several days in some\n cases. During the migration, the DB instance is available for use, but might experience\n performance degradation. While the migration takes place, nightly backups for the\n instance are suspended. No other Amazon RDS operations can take place for the instance,\n including modifying the instance, rebooting the instance, deleting the instance,\n creating a read replica for the instance, and creating a DB snapshot of the instance.

\n

Valid values: standard | gp2 | io1\n

\n

Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

" } }, "TdeCredentialArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The ARN from the key store with which to associate the instance for TDE encryption.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The ARN from the key store with which to associate the instance for TDE encryption.

\n

This setting doesn't apply to RDS Custom.

" } }, "TdeCredentialPassword": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The password for the given ARN from the key store in order to access the device.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The password for the given ARN from the key store in order to access the device.

\n

This setting doesn't apply to RDS Custom.

" } }, "CACertificateIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the certificate to associate with the DB instance.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

Specifies the certificate to associate with the DB instance.

\n

This setting doesn't apply to RDS Custom.

" } }, "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Active Directory directory ID to move the DB instance to. \n Specify none to remove the instance from its current domain.\n You must create the domain before this operation. Currently, you can create only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The Active Directory directory ID to move the DB instance to. \n Specify none to remove the instance from its current domain.\n You must create the domain before this operation. Currently, you can create only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" } }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

\n

\n Amazon Aurora\n

\n

Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting. For more\n information, see ModifyDBCluster.

" + "smithy.api#documentation": "

A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

\n

\n Amazon Aurora\n

\n

Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting. For more\n information, see ModifyDBCluster.

" } }, "MonitoringInterval": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected \n for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0, which is the default.

\n

If MonitoringRoleArn is specified, set MonitoringInterval to a value other than 0.

\n

This setting doesn't apply to RDS Custom.

\n

Valid Values: 0, 1, 5, 10, 15, 30, 60\n

" + "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected \n for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0, which is the default.

\n

If MonitoringRoleArn is specified, set MonitoringInterval to a value other than 0.

\n

This setting doesn't apply to RDS Custom.

\n

Valid Values: 0, 1, 5, 10, 15, 30, 60\n

" } }, "DBPortNumber": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

The value of the DBPortNumber parameter must not match any of the port values \n specified for options in the option group for the DB instance.

\n

If you change the DBPortNumber value, your database restarts regardless of \n the value of the ApplyImmediately parameter.

\n

This setting doesn't apply to RDS Custom.

\n

\n MySQL\n

\n

\n Default: 3306\n

\n

Valid values: 1150-65535\n

\n

\n MariaDB\n

\n

\n Default: 3306\n

\n

Valid values: 1150-65535\n

\n

\n PostgreSQL\n

\n

\n Default: 5432\n

\n

Valid values: 1150-65535\n

\n

Type: Integer

\n

\n Oracle\n

\n

\n Default: 1521\n

\n

Valid values: 1150-65535\n

\n

\n SQL Server\n

\n

\n Default: 1433\n

\n

Valid values: 1150-65535 except 1234, 1434,\n 3260, 3343, 3389, 47001, and\n 49152-49156.

\n

\n Amazon Aurora\n

\n

\n Default: 3306\n

\n

Valid values: 1150-65535\n

" + "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

The value of the DBPortNumber parameter must not match any of the port values \n specified for options in the option group for the DB instance.

\n

If you change the DBPortNumber value, your database restarts regardless of \n the value of the ApplyImmediately parameter.

\n

This setting doesn't apply to RDS Custom.

\n

\n MySQL\n

\n

Default: 3306\n

\n

Valid values: 1150-65535\n

\n

\n MariaDB\n

\n

Default: 3306\n

\n

Valid values: 1150-65535\n

\n

\n PostgreSQL\n

\n

Default: 5432\n

\n

Valid values: 1150-65535\n

\n

Type: Integer

\n

\n Oracle\n

\n

Default: 1521\n

\n

Valid values: 1150-65535\n

\n

\n SQL Server\n

\n

Default: 1433\n

\n

Valid values: 1150-65535 except 1234, 1434,\n 3260, 3343, 3389, 47001, and\n 49152-49156.

\n

\n Amazon Aurora\n

\n

Default: 3306\n

\n

Valid values: 1150-65535\n

" } }, "PubliclyAccessible": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is publicly accessible.\n

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

\n PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a \n public subnet and PubliclyAccessible must be enabled for it to be publicly accessible.\n

\n

Changes to the PubliclyAccessible parameter are applied immediately regardless\n of the value of the ApplyImmediately parameter.

" + "smithy.api#documentation": "

A value that indicates whether the DB instance is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

\n PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a \n public subnet and PubliclyAccessible must be enabled for it to be publicly accessible.

\n

Changes to the PubliclyAccessible parameter are applied immediately regardless\n of the value of the ApplyImmediately parameter.

" } }, "MonitoringRoleArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.\n

\n

If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn \n value.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.\n

\n

If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn \n value.

\n

This setting doesn't apply to RDS Custom.

" } }, "DomainIAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the IAM role to use when making API calls to the Directory Service.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The name of the IAM role to use when making API calls to the Directory Service.

\n

This setting doesn't apply to RDS Custom.

" } }, "PromotionTier": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

A value that specifies the order in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

\n

This setting doesn't apply to RDS Custom.\n

\n

Default: 1

\n

Valid Values: 0 - 15

" + "smithy.api#documentation": "

A value that specifies the order in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

\n

This setting doesn't apply to RDS Custom.

\n

Default: 1

\n

Valid Values: 0 - 15

" } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n

This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB\n cluster.

\n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n

This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB\n cluster.

\n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

\n

This setting doesn't apply to RDS Custom.

" } }, "EnablePerformanceInsights": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable Performance Insights for the DB instance.

\n

For more information, see \n Using Amazon Performance Insights in the Amazon Relational Database Service\n User Guide.\n

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

A value that indicates whether to enable Performance Insights for the DB instance.

\n

For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide..

\n

This setting doesn't apply to RDS Custom.

" } }, "PerformanceInsightsKMSKeyId": { @@ -14505,7 +14502,7 @@ "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.\n

" + "smithy.api#documentation": "

A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

" } }, "MaxAllocatedStorage": { @@ -14517,7 +14514,7 @@ "CertificateRotationRestart": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is restarted when you rotate your \n SSL/TLS certificate.

\n

By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate \n is not updated until the DB instance is restarted.

\n \n

Set this parameter only if you are not using SSL/TLS to connect to the DB instance.

\n \n

If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your \n DB engine to rotate your SSL/TLS certificate:

\n \n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

A value that indicates whether the DB instance is restarted when you rotate your \n SSL/TLS certificate.

\n

By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate \n is not updated until the DB instance is restarted.

\n \n

Set this parameter only if you are not using SSL/TLS to connect to the DB instance.

\n \n

If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your \n DB engine to rotate your SSL/TLS certificate:

\n \n

This setting doesn't apply to RDS Custom.

" } }, "ReplicaMode": { @@ -14547,7 +14544,7 @@ "ResumeFullAutomationModeMinutes": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of minutes to pause the automation. When the time period ends, RDS Custom resumes \n full automation. The minimum value is 60 (default). The maximum value is 1,440. \n

" + "smithy.api#documentation": "

The number of minutes to pause the automation. When the time period ends, RDS Custom resumes \n full automation. The minimum value is 60 (default). The maximum value is 1,440.

" } } }, @@ -14580,7 +14577,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Modifies the parameters of a DB parameter group. To modify more than one parameter,\n submit a list of the following: ParameterName, ParameterValue, and \n ApplyMethod. A maximum of 20 parameters can be modified in a single request.\n

\n \n

After you modify a DB parameter group, you should wait at least 5 minutes\n before creating your first DB instance that uses that DB parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the modify action before the parameter \n group is used as the default for a new DB instance. This is especially important for parameters \n that are critical when creating the default database for a DB instance, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBParameters command to verify \n that your DB parameter group has been created or modified.

\n " + "smithy.api#documentation": "

Modifies the parameters of a DB parameter group. To modify more than one parameter,\n submit a list of the following: ParameterName, ParameterValue, and \n ApplyMethod. A maximum of 20 parameters can be modified in a single request.

\n \n

After you modify a DB parameter group, you should wait at least 5 minutes\n before creating your first DB instance that uses that DB parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the modify action before the parameter \n group is used as the default for a new DB instance. This is especially important for parameters \n that are critical when creating the default database for a DB instance, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBParameters command to verify \n that your DB parameter group has been created or modified.

\n " } }, "com.amazonaws.rds#ModifyDBParameterGroupMessage": { @@ -14589,14 +14586,14 @@ "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the DB parameter group.

\n

Constraints:

\n ", + "smithy.api#documentation": "

The name of the DB parameter group.

\n

Constraints:

\n ", "smithy.api#required": {} } }, "Parameters": { "target": "com.amazonaws.rds#ParametersList", "traits": { - "smithy.api#documentation": "

An array of parameter names, values, and the application methods for the parameter update. At least one parameter name, value, and \n application method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a single request.

\n

Valid Values (for the application method): immediate | pending-reboot\n

\n

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic \n and static parameters.

\n

When the application method is immediate, changes to dynamic parameters are applied immediately to the DB instances associated with \n the parameter group.

\n

When the application method is pending-reboot, changes to dynamic and static parameters are applied after a reboot without failover \n to the DB instances associated with the parameter group.

\n \n

You can't use pending-reboot with dynamic parameters on RDS for SQL Server DB instances. Use immediate.

\n \n

For more information on modifying DB parameters, see Working \n with DB parameter groups in the Amazon RDS User Guide.

", + "smithy.api#documentation": "

An array of parameter names, values, and the application methods for the parameter update. At least one parameter name, value, and \n application method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a single request.

\n

Valid Values (for the application method): immediate | pending-reboot\n

\n

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic \n and static parameters.

\n

When the application method is immediate, changes to dynamic parameters are applied immediately to the DB instances associated with \n the parameter group.

\n

When the application method is pending-reboot, changes to dynamic and static parameters are applied after a reboot without failover \n to the DB instances associated with the parameter group.

\n \n

You can't use pending-reboot with dynamic parameters on RDS for SQL Server DB instances. Use immediate.

\n \n

For more information on modifying DB parameters, see Working \n with DB parameter groups in the Amazon RDS User Guide.

", "smithy.api#required": {} } } @@ -14833,7 +14830,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted\n or unencrypted, but not shared or public.\n \n

\n \n

Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This command\n doesn't apply to RDS Custom.\n

" + "smithy.api#documentation": "

Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted\n or unencrypted, but not shared or public.\n \n

\n

Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This command\n doesn't apply to RDS Custom.

" } }, "com.amazonaws.rds#ModifyDBSnapshotAttribute": { @@ -14856,7 +14853,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.

\n

To share a manual DB snapshot with other Amazon Web Services accounts, specify restore\n as the AttributeName and use the ValuesToAdd parameter to add\n a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB snapshot.\n Uses the value all to make the manual DB snapshot public, which means it\n can be copied or restored by all Amazon Web Services accounts.

\n \n

Don't add the all value for any manual DB snapshots that\n contain private information that you don't want available to all Amazon Web Services\n accounts.

\n \n

If the manual DB snapshot is encrypted, it can be shared, but only by specifying a\n list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You\n can't use all as a value for that parameter in this case.

\n

To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or\n whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API action. The accounts are returned as\n values for the restore attribute.

" + "smithy.api#documentation": "

Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.

\n

To share a manual DB snapshot with other Amazon Web Services accounts, specify restore\n as the AttributeName and use the ValuesToAdd parameter to add\n a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB snapshot.\n Uses the value all to make the manual DB snapshot public, which means it\n can be copied or restored by all Amazon Web Services accounts.

\n \n

Don't add the all value for any manual DB snapshots that\n contain private information that you don't want available to all Amazon Web Services\n accounts.

\n \n

If the manual DB snapshot is encrypted, it can be shared, but only by specifying a\n list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You\n can't use all as a value for that parameter in this case.

\n

To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or\n whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API action. The accounts are returned as\n values for the restore attribute.

" } }, "com.amazonaws.rds#ModifyDBSnapshotAttributeMessage": { @@ -14872,20 +14869,20 @@ "AttributeName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the DB snapshot attribute to modify.

\n

To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB snapshot, \n set this value to restore.

\n \n

To view the list of attributes available to modify, use the\n DescribeDBSnapshotAttributes API action.

\n ", + "smithy.api#documentation": "

The name of the DB snapshot attribute to modify.

\n

To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB snapshot, \n set this value to restore.

\n \n

To view the list of attributes available to modify, use the\n DescribeDBSnapshotAttributes API action.

\n ", "smithy.api#required": {} } }, "ValuesToAdd": { "target": "com.amazonaws.rds#AttributeValueList", "traits": { - "smithy.api#documentation": "

A list of DB snapshot attributes to add to the attribute specified by AttributeName.

\n

To authorize other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include one or more Amazon Web Services account\n IDs, or all to make the manual DB snapshot restorable by \n any Amazon Web Services account. Do not add the all value for any\n manual DB snapshots that contain private information that you don't want available\n to all Amazon Web Services accounts.

" + "smithy.api#documentation": "

A list of DB snapshot attributes to add to the attribute specified by AttributeName.

\n

To authorize other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include one or more Amazon Web Services account\n IDs, or all to make the manual DB snapshot restorable by \n any Amazon Web Services account. Do not add the all value for any\n manual DB snapshots that contain private information that you don't want available\n to all Amazon Web Services accounts.

" } }, "ValuesToRemove": { "target": "com.amazonaws.rds#AttributeValueList", "traits": { - "smithy.api#documentation": "

A list of DB snapshot attributes to remove from the attribute specified by AttributeName.

\n

To remove authorization for other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include \n one or more Amazon Web Services account\n identifiers, or all to remove authorization for any Amazon Web Services account to copy or\n restore the DB snapshot. If you specify all, an Amazon Web Services account whose\n account ID is explicitly added to the restore attribute\n can still copy or restore the manual DB snapshot.

" + "smithy.api#documentation": "

A list of DB snapshot attributes to remove from the attribute specified by AttributeName.

\n

To remove authorization for other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include \n one or more Amazon Web Services account\n identifiers, or all to remove authorization for any Amazon Web Services account to copy or\n restore the DB snapshot. If you specify all, an Amazon Web Services account whose\n account ID is explicitly added to the restore attribute\n can still copy or restore the manual DB snapshot.

" } } }, @@ -14914,13 +14911,13 @@ "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The engine version to upgrade the DB snapshot to.\n

\n \n

The following are the database engines and engine versions that are available when you upgrade a DB snapshot.\n

\n\n

\n MySQL\n

\n \n \n \n \n

\n Oracle\n

\n \n \n \n

\n PostgreSQL\n

\n

For the list of engine versions that are available for upgrading a DB snapshot, see \n \n Upgrading the PostgreSQL DB Engine for Amazon RDS.\n

" + "smithy.api#documentation": "

The engine version to upgrade the DB snapshot to.

\n

The following are the database engines and engine versions that are available when you upgrade a DB snapshot.

\n

\n MySQL\n

\n \n

\n Oracle\n

\n \n

\n PostgreSQL\n

\n

For the list of engine versions that are available for upgrading a DB snapshot, see \n \n Upgrading the PostgreSQL DB Engine for Amazon RDS.

" } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The option group to identify with the upgraded DB snapshot.\n

\n \n

You can specify this parameter when you upgrade an Oracle DB snapshot.\n The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance.\n For more information, see \n Option group considerations in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

The option group to identify with the upgraded DB snapshot.

\n

You can specify this parameter when you upgrade an Oracle DB snapshot.\n The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance.\n For more information, see \n Option group considerations in the Amazon RDS User Guide.\n

" } } } @@ -14968,7 +14965,7 @@ "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name for the DB subnet group. This value is stored as a lowercase string.\n You can't modify the default subnet group.\n

\n

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

\n

Example: mydbsubnetgroup\n

", + "smithy.api#documentation": "

The name for the DB subnet group. This value is stored as a lowercase string.\n You can't modify the default subnet group.

\n

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

\n

Example: mydbsubnetgroup\n

", "smithy.api#required": {} } }, @@ -15027,7 +15024,7 @@ } ], "traits": { - "smithy.api#documentation": "

Modifies an existing RDS event notification subscription. You can't modify the source identifiers using this call. To change \n source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.

\n

You can see a list of the event categories for a given source type (SourceType) \n in Events in the Amazon RDS User Guide \n or by using the DescribeEventCategories operation.

" + "smithy.api#documentation": "

Modifies an existing RDS event notification subscription. You can't modify the source identifiers using this call. To change \n source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.

\n

You can see a list of the event categories for a given source type (SourceType) \n in Events in the Amazon RDS User Guide \n or by using the DescribeEventCategories operation.

" } }, "com.amazonaws.rds#ModifyEventSubscriptionMessage": { @@ -15049,19 +15046,19 @@ "SourceType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are returned.

\n

Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n

" + "smithy.api#documentation": "

The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are returned.

\n

Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n

" } }, "EventCategories": { "target": "com.amazonaws.rds#EventCategoriesList", "traits": { - "smithy.api#documentation": "

\n A list of event categories for a source type (SourceType) that you want to subscribe to. \n You can see a list of the categories for a given source type \n in Events in the Amazon RDS User Guide \n or by using the DescribeEventCategories operation.\n

" + "smithy.api#documentation": "

A list of event categories for a source type (SourceType) that you want to subscribe to. \n You can see a list of the categories for a given source type \n in Events in the Amazon RDS User Guide \n or by using the DescribeEventCategories operation.

" } }, "Enabled": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

\n A value that indicates whether to activate the subscription.\n

" + "smithy.api#documentation": "

A value that indicates whether to activate the subscription.

" } } }, @@ -15100,7 +15097,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Modify a setting for an Amazon Aurora global cluster. You can change one or more database configuration\n parameters by specifying these parameters and the new values in the request. For more information on\n Amazon Aurora, see What is Amazon Aurora? in the\n Amazon Aurora User Guide.\n

\n \n

This action only applies to Aurora DB clusters.

\n " + "smithy.api#documentation": "

Modify a setting for an Amazon Aurora global cluster. You can change one or more database configuration\n parameters by specifying these parameters and the new values in the request. For more information on\n Amazon Aurora, see What is Amazon Aurora? in the\n Amazon Aurora User Guide.

\n \n

This action only applies to Aurora DB clusters.

\n " } }, "com.amazonaws.rds#ModifyGlobalClusterMessage": { @@ -15109,31 +15106,31 @@ "GlobalClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n The DB cluster identifier for the global cluster being modified. This parameter isn't case-sensitive.\n

\n

Constraints:

\n " + "smithy.api#documentation": "

The DB cluster identifier for the global cluster being modified. This parameter isn't case-sensitive.

\n

Constraints:

\n " } }, "NewGlobalClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n The new cluster identifier for the global database cluster when modifying a global database cluster.\n This value is stored as a lowercase string.\n

\n

Constraints:

\n \n

Example: my-cluster2\n

" + "smithy.api#documentation": "

The new cluster identifier for the global database cluster when modifying a global database cluster.\n This value is stored as a lowercase string.

\n

Constraints:

\n \n

Example: my-cluster2\n

" } }, "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

\n Indicates if the global database cluster has deletion protection enabled. The global database cluster\n can't be deleted when deletion protection is enabled.\n

" + "smithy.api#documentation": "

Indicates if the global database cluster has deletion protection enabled. The global database cluster\n can't be deleted when deletion protection is enabled.

" } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The version number of the database engine to which you want to upgrade. \n Changing this parameter results in an outage. The change is applied during\n the next maintenance window unless ApplyImmediately is enabled.

\n

To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'\n

\n

To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'\n

\n

To list all of the available engine versions for aurora-postgresql, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-postgresql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'\n

" + "smithy.api#documentation": "

The version number of the database engine to which you want to upgrade. \n Changing this parameter results in an outage. The change is applied during\n the next maintenance window unless ApplyImmediately is enabled.

\n

To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'\n

\n

To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'\n

\n

To list all of the available engine versions for aurora-postgresql, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-postgresql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'\n

" } }, "AllowMajorVersionUpgrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether major version upgrades are allowed.

\n

Constraints: You must allow major version upgrades when specifying a value for the\n EngineVersion parameter that is a different major version than the DB\n cluster's current version.

\n

If you upgrade the major version of a global database, the cluster and DB instance parameter\n groups are set to the default parameter groups for the new version. Apply any custom parameter\n groups after completing the upgrade.

" + "smithy.api#documentation": "

A value that indicates whether major version upgrades are allowed.

\n

Constraints: You must allow major version upgrades when specifying a value for the\n EngineVersion parameter that is a different major version than the DB\n cluster's current version.

\n

If you upgrade the major version of a global database, the cluster and DB instance parameter\n groups are set to the default parameter groups for the new version. Apply any custom parameter\n groups after completing the upgrade.

" } } } @@ -15172,7 +15169,7 @@ "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the option group to be modified.

\n

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

", + "smithy.api#documentation": "

The name of the option group to be modified.

\n

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

", "smithy.api#required": {} } }, @@ -15359,13 +15356,13 @@ "AllowsVpcAndNonVpcInstanceMemberships": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether this option group can be applied to both VPC \n and non-VPC instances. The value true indicates the option group \n can be applied to both VPC and non-VPC instances.\n

" + "smithy.api#documentation": "

Indicates whether this option group can be applied to both VPC \n and non-VPC instances. The value true indicates the option group \n can be applied to both VPC and non-VPC instances.

" } }, "VpcId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank.\n If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, \n then this option group can be applied to both VPC and non-VPC instances.\n If this field contains a value, then this option group can only be \n applied to instances that are in the VPC indicated by this field.\n

" + "smithy.api#documentation": "

If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank.\n If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, \n then this option group can be applied to both VPC and non-VPC instances.\n If this field contains a value, then this option group can only be \n applied to instances that are in the VPC indicated by this field.

" } }, "OptionGroupArn": { @@ -15408,7 +15405,7 @@ "Status": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The status of the DB instance's option group membership. Valid values are: \n in-sync, \n pending-apply, \n pending-removal, \n pending-maintenance-apply, \n pending-maintenance-removal, \n applying, \n removing, \n and failed.\n

" + "smithy.api#documentation": "

The status of the DB instance's option group membership. Valid values are: \n in-sync, \n pending-apply, \n pending-removal, \n pending-maintenance-apply, \n pending-maintenance-removal, \n applying, \n removing, \n and failed.

" } } }, @@ -15514,19 +15511,19 @@ "RequiresAutoMinorEngineVersionUpgrade": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

If true, you must enable the Auto Minor Version Upgrade setting for your DB instance \n before you can use this option.\n You can enable Auto Minor Version Upgrade when you first create your DB instance,\n or by modifying your DB instance later.\n

" + "smithy.api#documentation": "

If true, you must enable the Auto Minor Version Upgrade setting for your DB instance \n before you can use this option.\n You can enable Auto Minor Version Upgrade when you first create your DB instance,\n or by modifying your DB instance later.

" } }, "VpcOnly": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

If true, you can only use this option with a DB instance that is in a VPC.\n

" + "smithy.api#documentation": "

If true, you can only use this option with a DB instance that is in a VPC.

" } }, "SupportsOptionVersionDowngrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

If true, you can change the option to an earlier version of the option. \n This only applies to options that have different versions available.\n

" + "smithy.api#documentation": "

If true, you can change the option to an earlier version of the option. \n This only applies to options that have different versions available.

" } }, "OptionGroupOptionSettings": { @@ -15678,7 +15675,7 @@ "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" } } }, @@ -16007,7 +16004,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains a list of available options for a DB instance.

\n

\n This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.\n

" + "smithy.api#documentation": "

Contains a list of available options for a DB instance.

\n

This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.

" } }, "com.amazonaws.rds#OrderableDBInstanceOptionsList": { @@ -16031,12 +16028,12 @@ "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous \n OrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous \n OrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" } } }, "traits": { - "smithy.api#documentation": "

\n Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action. \n

" + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.

" } }, "com.amazonaws.rds#Outpost": { @@ -16050,7 +16047,7 @@ } }, "traits": { - "smithy.api#documentation": "

A data type that represents an Outpost.

\n

For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

A data type that represents an Outpost.

\n

For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.\n

" } }, "com.amazonaws.rds#Parameter": { @@ -16101,7 +16098,7 @@ "IsModifiable": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

\n Indicates whether (true) or not (false) the parameter can be modified.\n Some parameters have security or operational implications\n that prevent them from being changed.\n

" + "smithy.api#documentation": "

Indicates whether (true) or not (false) the parameter can be modified.\n Some parameters have security or operational implications\n that prevent them from being changed.

" } }, "MinimumEngineVersion": { @@ -16124,7 +16121,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n This data type is used as a request parameter in the\n ModifyDBParameterGroup and ResetDBParameterGroup actions.\n

\n

This data type is used as a response element in the \n DescribeEngineDefaultParameters and DescribeDBParameters actions.

" + "smithy.api#documentation": "

This data type is used as a request parameter in the\n ModifyDBParameterGroup and ResetDBParameterGroup actions.

\n

This data type is used as a response element in the \n DescribeEngineDefaultParameters and DescribeDBParameters actions.

" } }, "com.amazonaws.rds#ParametersList": { @@ -16174,7 +16171,7 @@ "ForcedApplyDate": { "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

The date when the maintenance action is automatically applied.

\n

On this date, the maintenance action is applied to the resource as soon as possible, \n regardless of the maintenance window for the resource. There might be a delay of \n one or more days from this date before the maintenance action is applied.

" + "smithy.api#documentation": "

The date when the maintenance action is automatically applied.

\n

On this date, the maintenance action is applied to the resource as soon as possible, \n regardless of the maintenance window for the resource. There might be a delay of \n one or more days from this date before the maintenance action is applied.

" } }, "OptInStatus": { @@ -16230,7 +16227,7 @@ "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous\n DescribePendingMaintenanceActions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to a number of records specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribePendingMaintenanceActions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to a number of records specified by MaxRecords.

" } } }, @@ -16343,12 +16340,12 @@ "ResumeFullAutomationModeTime": { "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. \n The minimum value is 60 (default). The maximum value is 1,440.\n

" + "smithy.api#documentation": "

The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. \n The minimum value is 60 (default). The maximum value is 1,440.

" } } }, "traits": { - "smithy.api#documentation": "

\n This data type is used as a response element in the ModifyDBInstance operation and \n contains changes that will be applied during the next maintenance window.\n

" + "smithy.api#documentation": "

This data type is used as a response element in the ModifyDBInstance operation and \n contains changes that will be applied during the next maintenance window.

" } }, "com.amazonaws.rds#PointInTimeRestoreNotEnabledFault": { @@ -16363,7 +16360,7 @@ "code": "PointInTimeRestoreNotEnabled", "httpResponseCode": 400 }, - "smithy.api#documentation": "

\n SourceDBInstanceIdentifier\n refers to a DB instance with\n BackupRetentionPeriod equal to 0.\n

", + "smithy.api#documentation": "

\n SourceDBInstanceIdentifier\n refers to a DB instance with\n BackupRetentionPeriod equal to 0.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -16385,7 +16382,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains the processor features of a DB instance class.

\n

To specify the number of CPU cores, use the coreCount feature name \n for the Name parameter. To specify the number of threads per core, use the\n threadsPerCore feature name for the Name parameter.

\n

You can set the processor features of the DB instance class for a DB instance when you\n call one of the following actions:

\n \n

You can view the valid processor values for a particular instance class by calling the\n DescribeOrderableDBInstanceOptions action and specifying the\n instance class for the DBInstanceClass parameter.

\n

In addition, you can use the following actions for DB instance class processor information:

\n \n

If you call DescribeDBInstances, ProcessorFeature returns\n non-null values only if the following conditions are met:

\n \n

For more information, see Configuring the\n Processor of the DB Instance Class in the Amazon RDS User Guide.\n \n

" + "smithy.api#documentation": "

Contains the processor features of a DB instance class.

\n

To specify the number of CPU cores, use the coreCount feature name \n for the Name parameter. To specify the number of threads per core, use the\n threadsPerCore feature name for the Name parameter.

\n

You can set the processor features of the DB instance class for a DB instance when you\n call one of the following actions:

\n \n

You can view the valid processor values for a particular instance class by calling the\n DescribeOrderableDBInstanceOptions action and specifying the\n instance class for the DBInstanceClass parameter.

\n

In addition, you can use the following actions for DB instance class processor information:

\n \n

If you call DescribeDBInstances, ProcessorFeature returns\n non-null values only if the following conditions are met:

\n \n

For more information, see Configuring the\n Processor of the DB Instance Class in the Amazon RDS User Guide.\n \n

" } }, "com.amazonaws.rds#ProcessorFeatureList": { @@ -16414,7 +16411,7 @@ } ], "traits": { - "smithy.api#documentation": "

Promotes a read replica DB instance to a standalone DB instance.

\n \n \n \n " + "smithy.api#documentation": "

Promotes a read replica DB instance to a standalone DB instance.

\n \n \n " } }, "com.amazonaws.rds#PromoteReadReplicaDBCluster": { @@ -16443,7 +16440,7 @@ "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The identifier of the DB cluster read replica to promote. This parameter isn't\n case-sensitive.

\n

Constraints:

\n \n

Example: my-cluster-replica1\n

", + "smithy.api#documentation": "

The identifier of the DB cluster read replica to promote. This parameter isn't\n case-sensitive.

\n

Constraints:

\n \n

Example: my-cluster-replica1\n

", "smithy.api#required": {} } } @@ -16466,20 +16463,20 @@ "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The DB instance identifier. This value is stored as a lowercase string.

\n

Constraints:

\n \n

Example: mydbinstance\n

", + "smithy.api#documentation": "

The DB instance identifier. This value is stored as a lowercase string.

\n

Constraints:

\n \n

Example: mydbinstance\n

", "smithy.api#required": {} } }, "BackupRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

\n

Default: 1

\n

Constraints:

\n " + "smithy.api#documentation": "

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

\n

Default: 1

\n

Constraints:

\n " } }, "PreferredBackupWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.\n

\n

\n The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To see the time blocks available, see \n \n Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.\n

\n

Constraints:

\n " + "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To see the time blocks available, see \n \n Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.\n

\n

Constraints:

\n " } } }, @@ -16541,20 +16538,20 @@ "ReservedDBInstancesOfferingId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The ID of the Reserved DB instance offering to purchase.

\n

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

", + "smithy.api#documentation": "

The ID of the Reserved DB instance offering to purchase.

\n

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

", "smithy.api#required": {} } }, "ReservedDBInstanceId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Customer-specified identifier to track this reservation.

\n

Example: myreservationID

" + "smithy.api#documentation": "

Customer-specified identifier to track this reservation.

\n

Example: myreservationID

" } }, "DBInstanceCount": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of instances to reserve.

\n

Default: 1\n

" + "smithy.api#documentation": "

The number of instances to reserve.

\n

Default: 1\n

" } }, "Tags": { @@ -16591,7 +16588,7 @@ "Step": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The step value for the range.\n For example, if you have a range of 5,000 to 10,000,\n with a step value of 1,000,\n the valid values start at 5,000 and step up by 1,000.\n Even though 7,500 is within the range,\n it isn't a valid value for the range.\n The valid values are 5,000, 6,000, 7,000, 8,000...\n

" + "smithy.api#documentation": "

The step value for the range.\n For example, if you have a range of 5,000 to 10,000,\n with a step value of 1,000,\n the valid values start at 5,000 and step up by 1,000.\n Even though 7,500 is within the range,\n it isn't a valid value for the range.\n The valid values are 5,000, 6,000, 7,000, 8,000...

" } } }, @@ -16661,7 +16658,7 @@ } ], "traits": { - "smithy.api#documentation": "

You might need to reboot your DB cluster, usually for maintenance reasons. \n For example, if you make certain modifications, \n or if you change the DB cluster parameter group associated with the DB cluster, \n reboot the DB cluster for the changes to take effect.\n

\n \n

Rebooting a DB cluster restarts the database engine service. Rebooting a DB \n cluster results in a momentary outage, during which the DB cluster status is set to rebooting.\n

\n \n

Use this operation only for a non-Aurora Multi-AZ DB cluster.

\n \n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the \n Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

You might need to reboot your DB cluster, usually for maintenance reasons. \n For example, if you make certain modifications, \n or if you change the DB cluster parameter group associated with the DB cluster, \n reboot the DB cluster for the changes to take effect.

\n

Rebooting a DB cluster restarts the database engine service. Rebooting a DB \n cluster results in a momentary outage, during which the DB cluster status is set to rebooting.

\n

Use this operation only for a non-Aurora Multi-AZ DB cluster.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the \n Amazon RDS User Guide.\n

" } }, "com.amazonaws.rds#RebootDBClusterMessage": { @@ -16670,7 +16667,7 @@ "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The DB cluster identifier. This parameter is stored as a lowercase string.

\n

Constraints:

\n ", + "smithy.api#documentation": "

The DB cluster identifier. This parameter is stored as a lowercase string.

\n

Constraints:

\n ", "smithy.api#required": {} } } @@ -16701,7 +16698,7 @@ } ], "traits": { - "smithy.api#documentation": "

You might need to reboot your DB instance, usually for maintenance reasons. \n For example, if you make certain modifications, \n or if you change the DB parameter group associated with the DB instance, \n you must reboot the instance for the changes to take effect.\n

\n\n

Rebooting a DB instance restarts the database engine service. \n Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.\n

\n \n

For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.\n

\n \n

This command doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

You might need to reboot your DB instance, usually for maintenance reasons. \n For example, if you make certain modifications, \n or if you change the DB parameter group associated with the DB instance, \n you must reboot the instance for the changes to take effect.

\n

Rebooting a DB instance restarts the database engine service. \n Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.

\n

For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.\n

\n

This command doesn't apply to RDS Custom.

" } }, "com.amazonaws.rds#RebootDBInstanceMessage": { @@ -16710,14 +16707,14 @@ "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The DB instance identifier. This parameter is stored as a lowercase string.

\n

Constraints:

\n ", + "smithy.api#documentation": "

The DB instance identifier. This parameter is stored as a lowercase string.

\n

Constraints:

\n ", "smithy.api#required": {} } }, "ForceFailover": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

\n A value that indicates whether the reboot is conducted through a Multi-AZ failover.\n

\n

Constraint: You can't enable force failover if the instance isn't configured for Multi-AZ.

" + "smithy.api#documentation": "

A value that indicates whether the reboot is conducted through a Multi-AZ failover.

\n

Constraint: You can't enable force failover if the instance isn't configured for Multi-AZ.

" } } }, @@ -16750,7 +16747,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n This data type is used as a response element in the \n DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.\n

" + "smithy.api#documentation": "

This data type is used as a response element in the \n DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.

" } }, "com.amazonaws.rds#RecurringChargeList": { @@ -16864,7 +16861,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a\n standalone cluster with read-write capability instead of being read-only and receiving data from a\n primary cluster in a different Region.\n

\n \n

This action only applies to Aurora DB clusters.

\n " + "smithy.api#documentation": "

Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a\n standalone cluster with read-write capability instead of being read-only and receiving data from a\n primary cluster in a different Region.

\n \n

This action only applies to Aurora DB clusters.

\n " } }, "com.amazonaws.rds#RemoveFromGlobalClusterMessage": { @@ -16873,13 +16870,13 @@ "GlobalClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n The cluster identifier to detach from the Aurora global database cluster.\n

" + "smithy.api#documentation": "

The cluster identifier to detach from the Aurora global database cluster.

" } }, "DbClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) identifying the cluster that was detached from the Aurora global database cluster.\n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) identifying the cluster that was detached from the Aurora global database cluster.

" } } } @@ -16909,7 +16906,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a\n DB cluster.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a\n DB cluster.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" } }, "com.amazonaws.rds#RemoveRoleFromDBClusterMessage": { @@ -16977,7 +16974,7 @@ "FeatureName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the feature for the DB instance that the IAM role is to be disassociated from.\n For information about supported feature names, see DBEngineVersion.\n

", + "smithy.api#documentation": "

The name of the feature for the DB instance that the IAM role is to be disassociated from.\n For information about supported feature names, see DBEngineVersion.

", "smithy.api#required": {} } } @@ -17016,7 +17013,7 @@ "SourceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n The source identifier to be removed from the subscription, such as the DB instance identifier \n for a DB instance or the name of a security group.\n

", + "smithy.api#documentation": "

The source identifier to be removed from the subscription, such as the DB instance identifier \n for a DB instance or the name of a security group.

", "smithy.api#required": {} } } @@ -17056,7 +17053,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes metadata tags from an Amazon RDS resource.

\n

For an overview on tagging an Amazon RDS resource, \n see Tagging Amazon RDS Resources \n in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

Removes metadata tags from an Amazon RDS resource.

\n

For an overview on tagging an Amazon RDS resource, \n see Tagging Amazon RDS Resources \n in the Amazon RDS User Guide.\n

" } }, "com.amazonaws.rds#RemoveTagsFromResourceMessage": { @@ -17192,12 +17189,12 @@ "LeaseId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The unique identifier for the lease associated with the reserved DB instance.

\n \n

Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.

\n " + "smithy.api#documentation": "

The unique identifier for the lease associated with the reserved DB instance.

\n \n

Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.

\n " } } }, "traits": { - "smithy.api#documentation": "

\n This data type is used as a response element in the \n DescribeReservedDBInstances and \n PurchaseReservedDBInstancesOffering actions.\n

" + "smithy.api#documentation": "

This data type is used as a response element in the \n DescribeReservedDBInstances and \n PurchaseReservedDBInstancesOffering actions.

" } }, "com.amazonaws.rds#ReservedDBInstanceAlreadyExistsFault": { @@ -17232,7 +17229,7 @@ "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" } }, "ReservedDBInstances": { @@ -17243,7 +17240,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n Contains the result of a successful invocation of the DescribeReservedDBInstances action.\n

" + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeReservedDBInstances action.

" } }, "com.amazonaws.rds#ReservedDBInstanceNotFoundFault": { @@ -17345,7 +17342,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n This data type is used as a response element in the DescribeReservedDBInstancesOfferings action.\n

" + "smithy.api#documentation": "

This data type is used as a response element in the DescribeReservedDBInstancesOfferings action.

" } }, "com.amazonaws.rds#ReservedDBInstancesOfferingList": { @@ -17363,7 +17360,7 @@ "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" } }, "ReservedDBInstancesOfferings": { @@ -17374,7 +17371,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action. \n

" + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.

" } }, "com.amazonaws.rds#ReservedDBInstancesOfferingNotFoundFault": { @@ -17411,7 +17408,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Modifies the parameters of a DB cluster parameter group to the default value. To\n reset specific parameters submit a list of the following: ParameterName \n and ApplyMethod. To reset the\n entire DB cluster parameter group, specify the DBClusterParameterGroupName \n and ResetAllParameters parameters.\n

\n

\n When resetting the entire group, dynamic parameters are updated immediately and static parameters\n are set to pending-reboot to take effect on the next DB instance restart \n or RebootDBInstance request. You must call RebootDBInstance for every\n DB instance in your DB cluster that you want the updated static parameter to apply to.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

Modifies the parameters of a DB cluster parameter group to the default value. To\n reset specific parameters submit a list of the following: ParameterName \n and ApplyMethod. To reset the\n entire DB cluster parameter group, specify the DBClusterParameterGroupName \n and ResetAllParameters parameters.

\n

When resetting the entire group, dynamic parameters are updated immediately and static parameters\n are set to pending-reboot to take effect on the next DB instance restart \n or RebootDBInstance request. You must call RebootDBInstance for every\n DB instance in your DB cluster that you want the updated static parameter to apply to.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" } }, "com.amazonaws.rds#ResetDBClusterParameterGroupMessage": { @@ -17458,7 +17455,7 @@ } ], "traits": { - "smithy.api#documentation": "

Modifies the parameters of a DB parameter group to the engine/system default value.\n To reset specific parameters, provide a list of the following:\n ParameterName and ApplyMethod. To reset the entire DB\n parameter group, specify the DBParameterGroup name and\n ResetAllParameters parameters. When resetting the entire group, dynamic\n parameters are updated immediately and static parameters are set to\n pending-reboot to take effect on the next DB instance restart or\n RebootDBInstance request.

" + "smithy.api#documentation": "

Modifies the parameters of a DB parameter group to the engine/system default value.\n To reset specific parameters, provide a list of the following:\n ParameterName and ApplyMethod. To reset the entire DB\n parameter group, specify the DBParameterGroup name and\n ResetAllParameters parameters. When resetting the entire group, dynamic\n parameters are updated immediately and static parameters are set to\n pending-reboot to take effect on the next DB instance restart or\n RebootDBInstance request.

" } }, "com.amazonaws.rds#ResetDBParameterGroupMessage": { @@ -17467,20 +17464,20 @@ "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the DB parameter group.

\n

Constraints:

\n ", + "smithy.api#documentation": "

The name of the DB parameter group.

\n

Constraints:

\n ", "smithy.api#required": {} } }, "ResetAllParameters": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

\n A value that indicates whether to reset all parameters in the DB parameter group to default values. \n By default, all parameters in the DB parameter group are reset to default values.\n

" + "smithy.api#documentation": "

A value that indicates whether to reset all parameters in the DB parameter group to default values. \n By default, all parameters in the DB parameter group are reset to default values.

" } }, "Parameters": { "target": "com.amazonaws.rds#ParametersList", "traits": { - "smithy.api#documentation": "

To reset the entire DB parameter group, specify the DBParameterGroup\n name and ResetAllParameters parameters. To reset specific parameters,\n provide a list of the following: ParameterName and\n ApplyMethod. A maximum of 20 parameters can be modified in a single\n request.

\n

\n MySQL\n

\n

Valid Values (for Apply method): immediate | pending-reboot\n

\n

You can use the immediate value with dynamic parameters only. You can use \n the pending-reboot value for both dynamic and static parameters, and changes \n are applied when DB instance reboots.

\n

\n MariaDB\n

\n

Valid Values (for Apply method): immediate | pending-reboot\n

\n

You can use the immediate value with dynamic parameters only. You can use \n the pending-reboot value for both dynamic and static parameters, and changes \n are applied when DB instance reboots.

\n

\n Oracle\n

\n

Valid Values (for Apply method): pending-reboot\n

" + "smithy.api#documentation": "

To reset the entire DB parameter group, specify the DBParameterGroup\n name and ResetAllParameters parameters. To reset specific parameters,\n provide a list of the following: ParameterName and\n ApplyMethod. A maximum of 20 parameters can be modified in a single\n request.

\n

\n MySQL\n

\n

Valid Values (for Apply method): immediate | pending-reboot\n

\n

You can use the immediate value with dynamic parameters only. You can use \n the pending-reboot value for both dynamic and static parameters, and changes \n are applied when DB instance reboots.

\n

\n MariaDB\n

\n

Valid Values (for Apply method): immediate | pending-reboot\n

\n

You can use the immediate value with dynamic parameters only. You can use \n the pending-reboot value for both dynamic and static parameters, and changes \n are applied when DB instance reboots.

\n

\n Oracle\n

\n

Valid Values (for Apply method): pending-reboot\n

" } } }, @@ -17578,7 +17575,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket.\n Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be\n created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the\n Amazon Aurora User Guide.

\n \n

This action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterFromS3 action has completed and the DB\n cluster is available.

\n \n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n

\n \n

This action only applies to Aurora DB clusters. The source DB engine must be\n MySQL.

\n " + "smithy.api#documentation": "

Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket.\n Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be\n created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the\n Amazon Aurora User Guide.

\n \n

This action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterFromS3 action has completed and the DB\n cluster is available.

\n \n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n \n

This action only applies to Aurora DB clusters. The source DB engine must be\n MySQL.

\n " } }, "com.amazonaws.rds#RestoreDBClusterFromS3Message": { @@ -17593,7 +17590,7 @@ "BackupRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.

\n

Default: 1

\n

Constraints:

\n " + "smithy.api#documentation": "

The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.

\n

Default: 1

\n

Constraints:

\n " } }, "CharacterSetName": { @@ -17611,14 +17608,14 @@ "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter isn't case-sensitive.

\n

Constraints:

\n \n

Example: my-cluster1\n

", + "smithy.api#documentation": "

The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter isn't case-sensitive.

\n

Constraints:

\n \n

Example: my-cluster1\n

", "smithy.api#required": {} } }, "DBClusterParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the DB cluster parameter group to associate\n with the restored DB cluster. If this argument is omitted, default.aurora5.6 is used.\n

\n

Constraints:

\n " + "smithy.api#documentation": "

The name of the DB cluster parameter group to associate\n with the restored DB cluster. If this argument is omitted, default.aurora5.6 is used.

\n

Constraints:

\n " } }, "VpcSecurityGroupIds": { @@ -17636,26 +17633,26 @@ "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the database engine to be used for this DB cluster.

\n

Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), and aurora-postgresql \n

", + "smithy.api#documentation": "

The name of the database engine to be used for this DB cluster.

\n

Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), and aurora-postgresql\n

", "smithy.api#required": {} } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The version number of the database engine to use.

\n

To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for aurora-postgresql, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n

\n

\n Aurora MySQL\n

\n

Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5, 8.0.mysql_aurora.3.01.0\n

\n

\n Aurora PostgreSQL\n

\n

Example: 9.6.3, 10.7\n

" + "smithy.api#documentation": "

The version number of the database engine to use.

\n

To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for aurora-postgresql, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n

\n

\n Aurora MySQL\n

\n

Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5, 8.0.mysql_aurora.3.01.0\n

\n

\n Aurora PostgreSQL\n

\n

Example: 9.6.3, 10.7\n

" } }, "Port": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The port number on which the instances in the restored DB cluster accept connections.

\n

\n Default: 3306\n

" + "smithy.api#documentation": "

The port number on which the instances in the restored DB cluster accept connections.

\n

Default: 3306\n

" } }, "MasterUsername": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the master user for the restored DB cluster.

\n

Constraints:

\n ", + "smithy.api#documentation": "

The name of the master user for the restored DB cluster.

\n

Constraints:

\n ", "smithy.api#required": {} } }, @@ -17675,13 +17672,13 @@ "PreferredBackupWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled\n using the BackupRetentionPeriod parameter.\n

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.\n

\n

Constraints:

\n " + "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled\n using the BackupRetentionPeriod parameter.

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.

\n

Constraints:

\n " } }, "PreferredMaintenanceWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.\n

\n

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

\n

Constraints: Minimum 30-minute window.

" + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.

\n

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

\n

Constraints: Minimum 30-minute window.

" } }, "Tags": { @@ -17702,20 +17699,20 @@ "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n \n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.\n

" + "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.

" } }, "SourceEngine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The identifier for the database engine that was backed up to create the files stored in the\n Amazon S3 bucket.\n

\n

Valid values: mysql\n

", + "smithy.api#documentation": "

The identifier for the database engine that was backed up to create the files stored in the\n Amazon S3 bucket.

\n

Valid values: mysql\n

", "smithy.api#required": {} } }, "SourceEngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The version of the database that the backup files were created from.

\n

MySQL versions 5.5, 5.6, and 5.7 are supported.\n

\n

Example: 5.6.40, 5.7.28\n

", + "smithy.api#documentation": "

The version of the database that the backup files were created from.

\n

MySQL versions 5.5, 5.6, and 5.7 are supported.

\n

Example: 5.6.40, 5.7.28\n

", "smithy.api#required": {} } }, @@ -17742,19 +17739,19 @@ "BacktrackWindow": { "target": "com.amazonaws.rds#LongOptional", "traits": { - "smithy.api#documentation": "

The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

\n \n

Currently, Backtrack is only supported for Aurora MySQL DB clusters.

\n \n

Default: 0

\n

Constraints:

\n " + "smithy.api#documentation": "

The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

\n \n

Currently, Backtrack is only supported for Aurora MySQL DB clusters.

\n \n

Default: 0

\n

Constraints:

\n " } }, "EnableCloudwatchLogsExports": { "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "

The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used.

\n

\n Aurora MySQL\n

\n

Possible values are audit, error, general, and slowquery.

\n

\n Aurora PostgreSQL\n

\n

Possible value is postgresql.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

" + "smithy.api#documentation": "

The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used.

\n

\n Aurora MySQL\n

\n

Possible values are audit, error, general, and slowquery.

\n

\n Aurora PostgreSQL\n

\n

Possible value is postgresql.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

" } }, "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.\n

" + "smithy.api#documentation": "

A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.

" } }, "CopyTagsToSnapshot": { @@ -17766,7 +17763,7 @@ "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specify the Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation.\n

\n

\n For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster.\n For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.\n

" + "smithy.api#documentation": "

Specify the Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation.

\n

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster.\n For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.

" } }, "DomainIAMRoleName": { @@ -17847,7 +17844,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

\n

The target DB cluster is created from the source snapshot with a default\n configuration. If you don't specify a security group, the new DB cluster is\n associated with the default security group.

\n \n

This action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterFromSnapshot action has completed and the DB\n cluster is available.

\n \n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

\n

The target DB cluster is created from the source snapshot with a default\n configuration. If you don't specify a security group, the new DB cluster is\n associated with the default security group.

\n \n

This action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterFromSnapshot action has completed and the DB\n cluster is available.

\n \n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" } }, "com.amazonaws.rds#RestoreDBClusterFromSnapshotMessage": { @@ -17856,100 +17853,100 @@ "AvailabilityZones": { "target": "com.amazonaws.rds#AvailabilityZones", "traits": { - "smithy.api#documentation": "

Provides the list of Availability Zones (AZs) where instances in the restored DB\n cluster can be created.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

Provides the list of Availability Zones (AZs) where instances in the restored DB\n cluster can be created.

\n

Valid for: Aurora DB clusters only

" } }, "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the DB cluster to create from the DB snapshot or DB cluster snapshot.\n This parameter isn't case-sensitive.

\n

Constraints:

\n \n

Example: my-snapshot-id\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", + "smithy.api#documentation": "

The name of the DB cluster to create from the DB snapshot or DB cluster snapshot.\n This parameter isn't case-sensitive.

\n

Constraints:

\n \n

Example: my-snapshot-id\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", "smithy.api#required": {} } }, "SnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The identifier for the DB snapshot or DB cluster snapshot to restore from.

\n

You can use either the name or the Amazon Resource Name (ARN) to specify a DB\n cluster snapshot. However, you can use only the ARN to specify a DB snapshot.

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", + "smithy.api#documentation": "

The identifier for the DB snapshot or DB cluster snapshot to restore from.

\n

You can use either the name or the Amazon Resource Name (ARN) to specify a DB\n cluster snapshot. However, you can use only the ARN to specify a DB snapshot.

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", "smithy.api#required": {} } }, "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The database engine to use for the new DB cluster.

\n

Default: The same as source

\n

Constraint: Must be compatible with the engine of the source

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", + "smithy.api#documentation": "

The database engine to use for the new DB cluster.

\n

Default: The same as source

\n

Constraint: Must be compatible with the engine of the source

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", "smithy.api#required": {} } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The version of the database engine to use for the new DB cluster.

\n

To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for Aurora PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for MySQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n

\n

\n Aurora MySQL\n

\n

See MySQL on Amazon RDS Versions in the \n Amazon Aurora User Guide.\n

\n

\n Aurora PostgreSQL\n

\n

See Amazon Aurora PostgreSQL releases and engine versions in the \n Amazon Aurora User Guide.\n

\n

\n MySQL\n

\n

See MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.\n

\n

\n PostgreSQL\n

\n

See Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The version of the database engine to use for the new DB cluster.

\n

To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for Aurora PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for MySQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n

\n

\n Aurora MySQL\n

\n

See MySQL on Amazon RDS Versions in the \n Amazon Aurora User Guide.

\n

\n Aurora PostgreSQL\n

\n

See Amazon Aurora PostgreSQL releases and engine versions in the \n Amazon Aurora User Guide.

\n

\n MySQL\n

\n

See MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.\n

\n

\n PostgreSQL\n

\n

See Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "Port": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The port number on which the new DB cluster accepts connections.

\n

Constraints: This value must be 1150-65535\n

\n

Default: The same port as the original DB cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The port number on which the new DB cluster accepts connections.

\n

Constraints: This value must be 1150-65535\n

\n

Default: The same port as the original DB cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the DB subnet group to use for the new DB cluster.

\n

Constraints: If supplied, must match the name of an existing DB subnet group.

\n

Example: mydbsubnetgroup\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The name of the DB subnet group to use for the new DB cluster.

\n

Constraints: If supplied, must match the name of an existing DB subnet group.

\n

Example: mydbsubnetgroup\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "DatabaseName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The database name for the restored DB cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The database name for the restored DB cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the option group to use for the restored DB cluster.

\n

DB clusters are associated with a default option group that can't be modified.

" + "smithy.api#documentation": "

The name of the option group to use for the restored DB cluster.

\n

DB clusters are associated with a default option group that can't be modified.

" } }, "VpcSecurityGroupIds": { "target": "com.amazonaws.rds#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "

A list of VPC security groups that the new DB cluster will belong to.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

A list of VPC security groups that the new DB cluster will belong to.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "Tags": { "target": "com.amazonaws.rds#TagList", "traits": { - "smithy.api#documentation": "

The tags to be assigned to the restored DB cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The tags to be assigned to the restored DB cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB\n snapshot or DB cluster snapshot.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

When you don't specify a value for the KmsKeyId parameter, then the\n following occurs:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB\n snapshot or DB cluster snapshot.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

When you don't specify a value for the KmsKeyId parameter, then the\n following occurs:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.\n

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" } }, "BacktrackWindow": { "target": "com.amazonaws.rds#LongOptional", "traits": { - "smithy.api#documentation": "

The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

\n \n

Currently, Backtrack is only supported for Aurora MySQL DB clusters.

\n \n

Default: 0

\n

Constraints:

\n \n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

\n \n

Currently, Backtrack is only supported for Aurora MySQL DB clusters.

\n \n

Default: 0

\n

Constraints:

\n \n

Valid for: Aurora DB clusters only

" } }, "EnableCloudwatchLogsExports": { "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "

The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.\n The values in the list depend on the DB engine being used.

\n

\n RDS for MySQL\n

\n

Possible values are error, general, and slowquery.

\n

\n RDS for PostgreSQL\n

\n

Possible values are postgresql and upgrade.

\n

\n Aurora MySQL\n

\n

Possible values are audit, error, general, and slowquery.

\n

\n Aurora PostgreSQL\n

\n

Possible value is postgresql.

\n

For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database\n Service User Guide.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.\n The values in the list depend on the DB engine being used.

\n

\n RDS for MySQL\n

\n

Possible values are error, general, and slowquery.

\n

\n RDS for PostgreSQL\n

\n

Possible values are postgresql and upgrade.

\n

\n Aurora MySQL\n

\n

Possible values are audit, error, general, and slowquery.

\n

\n Aurora PostgreSQL\n

\n

Possible value is postgresql.

\n

For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide..

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "EngineMode": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The DB engine mode of the DB cluster, either provisioned, serverless,\n parallelquery, global, or multimaster.

\n

For more information, see \n CreateDBCluster.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

The DB engine mode of the DB cluster, either provisioned, serverless,\n parallelquery, global, or multimaster.

\n

For more information, see \n CreateDBCluster.

\n

Valid for: Aurora DB clusters only

" } }, "ScalingConfiguration": { @@ -17961,7 +17958,7 @@ "DBClusterParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the DB cluster parameter group to associate with this DB cluster. If this\n argument is omitted, the default DB cluster parameter group for the specified engine is\n used.

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The name of the DB cluster parameter group to associate with this DB cluster. If this\n argument is omitted, the default DB cluster parameter group for the specified engine is\n used.

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "DeletionProtection": { @@ -17979,7 +17976,7 @@ "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specify the Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

Specify the Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

Valid for: Aurora DB clusters only

" } }, "DomainIAMRoleName": { @@ -17991,25 +17988,25 @@ "DBClusterInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

\n

For the full list of DB instance classes, and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n

\n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

\n

For the full list of DB instance classes, and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n

\n

Valid for: Multi-AZ DB clusters only

" } }, "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.

\n

\n Valid values: io1\n

\n

\n When specified, a value for the Iops parameter is required.\n

\n

\n Default: io1\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.

\n

Valid values: io1\n

\n

When specified, a value for the Iops parameter is required.

\n

Default: io1\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "Iops": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for \n each DB instance in the Multi-AZ DB cluster.

\n

For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.\n

\n

Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for \n each DB instance in the Multi-AZ DB cluster.

\n

For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.

\n

Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "PubliclyAccessible": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB cluster is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. \n Access to the DB cluster is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.

\n

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

\n

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

\n

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

A value that indicates whether the DB cluster is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. \n Access to the DB cluster is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.

\n

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

\n

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

\n

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } } }, @@ -18090,7 +18087,7 @@ } ], "traits": { - "smithy.api#documentation": "

Restores a DB cluster to an arbitrary point in time. Users can restore to any point\n in time before LatestRestorableTime for up to\n BackupRetentionPeriod days. The target DB cluster is created from the\n source DB cluster with the same configuration as the original DB cluster, except that\n the new DB cluster is created with the default DB security group.

\n \n

For Aurora, this action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterToPointInTime action has completed and the DB\n cluster is available.

\n \n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

Restores a DB cluster to an arbitrary point in time. Users can restore to any point\n in time before LatestRestorableTime for up to\n BackupRetentionPeriod days. The target DB cluster is created from the\n source DB cluster with the same configuration as the original DB cluster, except that\n the new DB cluster is created with the default DB security group.

\n \n

For Aurora, this action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterToPointInTime action has completed and the DB\n cluster is available.

\n \n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" } }, "com.amazonaws.rds#RestoreDBClusterToPointInTimeMessage": { @@ -18099,57 +18096,57 @@ "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the new DB cluster to be created.

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", + "smithy.api#documentation": "

The name of the new DB cluster to be created.

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", "smithy.api#required": {} } }, "RestoreType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The type of restore to be performed. You can specify one of the following values:

\n \n

Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11.

\n

If you don't specify a RestoreType value, then the new DB cluster is\n restored as a full copy of the source DB cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The type of restore to be performed. You can specify one of the following values:

\n \n

Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11.

\n

If you don't specify a RestoreType value, then the new DB cluster is\n restored as a full copy of the source DB cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "SourceDBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The identifier of the source DB cluster from which to restore.

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", + "smithy.api#documentation": "

The identifier of the source DB cluster from which to restore.

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", "smithy.api#required": {} } }, "RestoreToTime": { "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

The date and time to restore the DB cluster to.

\n

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

\n

Constraints:

\n \n

Example: 2015-03-07T23:45:00Z\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The date and time to restore the DB cluster to.

\n

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

\n

Constraints:

\n \n

Example: 2015-03-07T23:45:00Z\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "UseLatestRestorableTime": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

A value that indicates whether to restore the DB cluster to the latest \n restorable backup time. By default, the DB cluster isn't restored to the latest \n restorable backup time.\n

\n

Constraints: Can't be specified if RestoreToTime parameter is provided.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

A value that indicates whether to restore the DB cluster to the latest \n restorable backup time. By default, the DB cluster isn't restored to the latest \n restorable backup time.

\n

Constraints: Can't be specified if RestoreToTime parameter is provided.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "Port": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The port number on which the new DB cluster accepts connections.

\n

Constraints: A value from 1150-65535.\n

\n

Default: The default port for the engine.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The port number on which the new DB cluster accepts connections.

\n

Constraints: A value from 1150-65535.

\n

Default: The default port for the engine.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The DB subnet group name to use for the new DB cluster.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mydbsubnetgroup\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The DB subnet group name to use for the new DB cluster.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mydbsubnetgroup\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the option group for the new DB cluster.

\n

DB clusters are associated with a default option group that can't be modified.

" + "smithy.api#documentation": "

The name of the option group for the new DB cluster.

\n

DB clusters are associated with a default option group that can't be modified.

" } }, "VpcSecurityGroupIds": { "target": "com.amazonaws.rds#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "

A list of VPC security groups that the new DB cluster belongs to.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

A list of VPC security groups that the new DB cluster belongs to.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "Tags": { @@ -18158,31 +18155,31 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different from the\n KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key\n identified by the KmsKeyId parameter.

\n

If you don't specify a value for the KmsKeyId parameter, then the following occurs:

\n \n

If DBClusterIdentifier refers to a DB cluster that isn't encrypted, then the restore request\n is rejected.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different from the\n KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key\n identified by the KmsKeyId parameter.

\n

If you don't specify a value for the KmsKeyId parameter, then the following occurs:

\n \n

If DBClusterIdentifier refers to a DB cluster that isn't encrypted, then the restore request\n is rejected.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.\n

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" } }, "BacktrackWindow": { "target": "com.amazonaws.rds#LongOptional", "traits": { - "smithy.api#documentation": "

The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

\n

Default: 0

\n

Constraints:

\n \n

Valid for: Aurora MySQL DB clusters only

" + "smithy.api#documentation": "

The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

\n

Default: 0

\n

Constraints:

\n \n

Valid for: Aurora MySQL DB clusters only

" } }, "EnableCloudwatchLogsExports": { "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "

The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used.

\n

\n RDS for MySQL\n

\n

Possible values are error, general, and slowquery.

\n

\n RDS for PostgreSQL\n

\n

Possible values are postgresql and upgrade.

\n

\n Aurora MySQL\n

\n

Possible values are audit, error, general, and slowquery.

\n

\n Aurora PostgreSQL\n

\n

Possible value is postgresql.

\n

For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database\n Service User Guide.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used.

\n

\n RDS for MySQL\n

\n

Possible values are error, general, and slowquery.

\n

\n RDS for PostgreSQL\n

\n

Possible values are postgresql and upgrade.

\n

\n Aurora MySQL\n

\n

Possible values are audit, error, general, and slowquery.

\n

\n Aurora PostgreSQL\n

\n

Possible value is postgresql.

\n

For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide..

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "DBClusterParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the DB cluster parameter group to associate with this DB cluster. \n If this argument is omitted, the default DB cluster parameter group for the specified engine is used.

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The name of the DB cluster parameter group to associate with this DB cluster. \n If this argument is omitted, the default DB cluster parameter group for the specified engine is used.

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "DeletionProtection": { @@ -18200,7 +18197,7 @@ "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specify the Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation.\n

\n

\n For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster.\n For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.\n

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

Specify the Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation.

\n

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster.\n For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" } }, "DomainIAMRoleName": { @@ -18218,31 +18215,31 @@ "EngineMode": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The engine mode of the new cluster. Specify provisioned or serverless,\n depending on the type of the cluster you are creating. You can create an Aurora Serverless clone\n from a provisioned cluster, or a provisioned clone from an Aurora Serverless cluster. To create a clone\n that is an Aurora Serverless cluster, the original cluster must be an Aurora Serverless cluster or\n an encrypted provisioned cluster.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

The engine mode of the new cluster. Specify provisioned or serverless,\n depending on the type of the cluster you are creating. You can create an Aurora Serverless v1 clone\n from a provisioned cluster, or a provisioned clone from an Aurora Serverless v1 cluster. To create a clone\n that is an Aurora Serverless v1 cluster, the original cluster must be an Aurora Serverless v1 cluster or\n an encrypted provisioned cluster.

\n

Valid for: Aurora DB clusters only

" } }, "DBClusterInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster,\n for example db.m6g.xlarge. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines.

\n

For the full list of DB instance classes, and availability for your engine, see DB instance class in the Amazon RDS User Guide.\n

\n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster,\n for example db.m6g.xlarge. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines.

\n

For the full list of DB instance classes, and availability for your engine, see DB instance class in the Amazon RDS User Guide.\n

\n

Valid for: Multi-AZ DB clusters only

" } }, "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.

\n

\n Valid values: io1\n

\n

\n When specified, a value for the Iops parameter is required.\n

\n

\n Default: io1\n

\n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.

\n

Valid values: io1\n

\n

When specified, a value for the Iops parameter is required.

\n

Default: io1\n

\n

Valid for: Multi-AZ DB clusters only

" } }, "PubliclyAccessible": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB cluster is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB cluster's virtual private cloud (VPC). It resolves\n to the public IP address from outside of the DB cluster's VPC. \n Access to the DB cluster is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.

\n

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

\n

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

\n

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

A value that indicates whether the DB cluster is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB cluster's virtual private cloud (VPC). It resolves\n to the public IP address from outside of the DB cluster's VPC. \n Access to the DB cluster is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.

\n

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

\n

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

\n

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

Valid for: Multi-AZ DB clusters only

" } }, "Iops": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for \n each DB instance in the Multi-AZ DB cluster.

\n

For information about valid Iops values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide.\n

\n

Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance. \n

\n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for \n each DB instance in the Multi-AZ DB cluster.

\n

For information about valid Iops values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide.

\n

Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.

\n

Valid for: Multi-AZ DB clusters only

" } } }, @@ -18329,7 +18326,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with most\n of the source's original configuration, including the default security group and DB parameter group. By default, the new DB\n instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group\n associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment.

\n

If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance\n before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn't allow two DB instances with the same name. After you\n have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as\n the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you replace the original\n DB instance with the DB instance created from the snapshot.

\n

If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier\n must be the ARN of the shared DB snapshot.

\n \n

This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot.

\n " + "smithy.api#documentation": "

Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with most\n of the source's original configuration, including the default security group and DB parameter group. By default, the new DB\n instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group\n associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment.

\n

If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance\n before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn't allow two DB instances with the same name. After you\n have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as\n the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you replace the original\n DB instance with the DB instance created from the snapshot.

\n

If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier\n must be the ARN of the shared DB snapshot.

\n \n

This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot.

\n " } }, "com.amazonaws.rds#RestoreDBInstanceFromDBSnapshotMessage": { @@ -18338,87 +18335,87 @@ "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.

\n

Constraints:

\n \n

Example: my-snapshot-id\n

", + "smithy.api#documentation": "

Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.

\n

Constraints:

\n \n

Example: my-snapshot-id\n

", "smithy.api#required": {} } }, "DBSnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The identifier for the DB snapshot to restore from.

\n

Constraints:

\n ", + "smithy.api#documentation": "

The identifier for the DB snapshot to restore from.

\n

Constraints:

\n ", "smithy.api#required": {} } }, "DBInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n

\n

Default: The same DBInstanceClass as the original DB instance.

" + "smithy.api#documentation": "

The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n

\n

Default: The same DBInstanceClass as the original DB instance.

" } }, "Port": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

Default: The same port as the original DB instance

\n

Constraints: Value must be 1150-65535\n

" + "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

Default: The same port as the original DB instance

\n

Constraints: Value must be 1150-65535\n

" } }, "AvailabilityZone": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Availability Zone (AZ) where the DB instance will be created.

\n

Default: A random, system-chosen Availability Zone.

\n

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

\n

Example: us-east-1a\n

" + "smithy.api#documentation": "

The Availability Zone (AZ) where the DB instance will be created.

\n

Default: A random, system-chosen Availability Zone.

\n

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

\n

Example: us-east-1a\n

" } }, "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The DB subnet group name to use for the new instance.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mydbsubnetgroup\n

" + "smithy.api#documentation": "

The DB subnet group name to use for the new instance.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mydbsubnetgroup\n

" } }, "MultiAZ": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is a Multi-AZ deployment.

\n

This setting doesn't apply to RDS Custom.

\n

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

" + "smithy.api#documentation": "

A value that indicates whether the DB instance is a Multi-AZ deployment.

\n

This setting doesn't apply to RDS Custom.

\n

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

" } }, "PubliclyAccessible": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is publicly accessible.

\n

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB instance's virtual private cloud (VPC). \n It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled \n by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

" + "smithy.api#documentation": "

A value that indicates whether the DB instance is publicly accessible.

\n

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB instance's virtual private cloud (VPC). \n It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled \n by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether minor version upgrades are applied automatically to the DB instance \n during the maintenance window.

\n

If you restore an RDS Custom DB instance, you must disable this parameter.

" + "smithy.api#documentation": "

A value that indicates whether minor version upgrades are applied automatically to the DB instance \n during the maintenance window.

\n

If you restore an RDS Custom DB instance, you must disable this parameter.

" } }, "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

License model information for the restored DB instance.

\n

This setting doesn't apply to RDS Custom.

\n

Default: Same as source.

\n

\n Valid values: license-included | bring-your-own-license | general-public-license\n

" + "smithy.api#documentation": "

License model information for the restored DB instance.

\n

This setting doesn't apply to RDS Custom.

\n

Default: Same as source.

\n

Valid values: license-included | bring-your-own-license | general-public-license\n

" } }, "DBName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The database name for the restored DB instance.

\n

This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines. It also doesn't apply to RDS\n Custom DB instances.

" + "smithy.api#documentation": "

The database name for the restored DB instance.

\n

This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines. It also doesn't apply to RDS\n Custom DB instances.

" } }, "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The database engine to use for the new instance.

\n

This setting doesn't apply to RDS Custom.

\n

Default: The same as source

\n

Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.

\n\n

Valid Values:

\n \n " + "smithy.api#documentation": "

The database engine to use for the new instance.

\n

This setting doesn't apply to RDS Custom.

\n

Default: The same as source

\n

Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.

\n

Valid Values:

\n " } }, "Iops": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. \n If this parameter isn't specified, the IOPS value is taken from the backup. \n If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. \n The conversion takes additional time, though your DB instance is available for connections before the conversion starts.\n

\n

The provisioned IOPS value must follow the requirements for your database engine.\n For more information, see \n Amazon RDS Provisioned IOPS Storage to Improve Performance \n in the Amazon RDS User Guide.\n

\n

Constraints: Must be an integer greater than 1000.

" + "smithy.api#documentation": "

Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. \n If this parameter isn't specified, the IOPS value is taken from the backup. \n If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. \n The conversion takes additional time, though your DB instance is available for connections before the conversion starts.

\n

The provisioned IOPS value must follow the requirements for your database engine.\n For more information, see \n Amazon RDS Provisioned IOPS Storage to Improve Performance \n in the Amazon RDS User Guide.\n

\n

Constraints: Must be an integer greater than 1000.

" } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the option group to be used for the restored DB instance.

\n \n

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option \n group, and that option group can't be removed from a DB instance after it is associated with a DB instance.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The name of the option group to be used for the restored DB instance.

\n \n \n

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option \n group, and that option group can't be removed from a DB instance after it is associated with a DB instance.

\n

This setting doesn't apply to RDS Custom.

" } }, "Tags": { @@ -18427,49 +18424,49 @@ "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.

\n

\n Valid values: standard | gp2 | io1\n

\n

\n If you specify io1, you must also include a value for the\n Iops parameter.\n

\n

\n Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

" + "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.

\n

Valid values: standard | gp2 | io1\n

\n

If you specify io1, you must also include a value for the\n Iops parameter.

\n

Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

" } }, "TdeCredentialArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The ARN from the key store with which to associate the instance for TDE encryption.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The ARN from the key store with which to associate the instance for TDE encryption.

\n

This setting doesn't apply to RDS Custom.

" } }, "TdeCredentialPassword": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The password for the given ARN from the key store in order to access the device.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The password for the given ARN from the key store in order to access the device.

\n

This setting doesn't apply to RDS Custom.

" } }, "VpcSecurityGroupIds": { "target": "com.amazonaws.rds#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "

\n A list of EC2 VPC security groups to associate with this DB instance.\n

\n

\n Default: The default EC2 VPC security group for the DB subnet group's VPC.\n

" + "smithy.api#documentation": "

A list of EC2 VPC security groups to associate with this DB instance.

\n

Default: The default EC2 VPC security group for the DB subnet group's VPC.

" } }, "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specify the Active Directory directory ID to restore the DB instance in.\n The domain/ must be created prior to this operation. Currently, you can create only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

Specify the Active Directory directory ID to restore the DB instance in.\n The domain/ must be created prior to this operation. Currently, you can create only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" } }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance.

\n

In most cases, tags aren't copied by default. However, when you restore a DB instance from a DB snapshot, RDS checks whether you \n specify new tags. If yes, the new tags are added to the restored DB instance. If there are no new tags, RDS looks for the tags from\n the source DB instance for the DB snapshot, and then adds those tags to the restored DB instance.

\n

For more information, see \n Copying tags to DB instance snapshots in the Amazon RDS User Guide.

" + "smithy.api#documentation": "

A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance.

\n

In most cases, tags aren't copied by default. However, when you restore a DB instance from a DB snapshot, RDS checks whether you \n specify new tags. If yes, the new tags are added to the restored DB instance. If there are no new tags, RDS looks for the tags from\n the source DB instance for the DB snapshot, and then adds those tags to the restored DB instance.

\n

For more information, see \n Copying tags to DB instance snapshots in the Amazon RDS User Guide.

" } }, "DomainIAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

\n

This setting doesn't apply to RDS Custom.

" } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.

\n\n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.

\n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

\n

This setting doesn't apply to RDS Custom.

" } }, "EnableCloudwatchLogsExports": { @@ -18499,7 +18496,7 @@ "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.\n

" + "smithy.api#documentation": "

A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

" } }, "EnableCustomerOwnedIp": { @@ -18511,7 +18508,7 @@ "CustomIamInstanceProfile": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n \n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

\n

This setting is required for RDS Custom.

" + "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n \n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

\n

This setting is required for RDS Custom.

" } }, "BackupTarget": { @@ -18595,7 +18592,7 @@ } ], "traits": { - "smithy.api#documentation": "

Amazon Relational Database Service (Amazon RDS) \n supports importing MySQL databases by using backup files. \n You can create a backup of your on-premises database, \n store it on Amazon Simple Storage Service (Amazon S3), \n and then restore the backup file onto a new Amazon RDS DB instance running MySQL.\n For more information, see Importing Data into an Amazon RDS MySQL DB Instance \n in the Amazon RDS User Guide. \n

\n

This command doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

Amazon Relational Database Service (Amazon RDS) \n supports importing MySQL databases by using backup files. \n You can create a backup of your on-premises database, \n store it on Amazon Simple Storage Service (Amazon S3), \n and then restore the backup file onto a new Amazon RDS DB instance running MySQL.\n For more information, see Importing Data into an Amazon RDS MySQL DB Instance \n in the Amazon RDS User Guide.\n

\n

This command doesn't apply to RDS Custom.

" } }, "com.amazonaws.rds#RestoreDBInstanceFromS3Message": { @@ -18604,46 +18601,46 @@ "DBName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the database to create when the DB instance is created.\n Follow the naming rules specified in CreateDBInstance.\n

" + "smithy.api#documentation": "

The name of the database to create when the DB instance is created.\n Follow the naming rules specified in CreateDBInstance.

" } }, "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The DB instance identifier. This parameter is stored as a lowercase string.\n

\n\n

Constraints:

\n\n \n\n

Example: mydbinstance\n

", + "smithy.api#documentation": "

The DB instance identifier. This parameter is stored as a lowercase string.

\n

Constraints:

\n \n

Example: mydbinstance\n

", "smithy.api#required": {} } }, "AllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The amount of storage (in gigabytes) to allocate initially for the DB instance.\n Follow the allocation rules specified in CreateDBInstance.\n

\n \n \n

Be sure to allocate enough memory for your new DB instance\n so that the restore operation can succeed.\n You can also allocate additional memory for future growth. \n

\n " + "smithy.api#documentation": "

The amount of storage (in gigabytes) to allocate initially for the DB instance.\n Follow the allocation rules specified in CreateDBInstance.

\n \n

Be sure to allocate enough memory for your new DB instance\n so that the restore operation can succeed.\n You can also allocate additional memory for future growth.

\n " } }, "DBInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the DB instance, \n for example db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, \n or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.\n

\n

Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class.\n

", + "smithy.api#documentation": "

The compute and memory capacity of the DB instance, \n for example db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, \n or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.\n

\n

Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class.

", "smithy.api#required": {} } }, "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the database engine to be used for this instance.\n

\n \n

Valid Values: mysql\n

", + "smithy.api#documentation": "

The name of the database engine to be used for this instance.

\n

Valid Values: \n mysql\n

", "smithy.api#required": {} } }, "MasterUsername": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name for the master user.\n

\n \n

Constraints:\n

\n " + "smithy.api#documentation": "

The name for the master user.

\n

Constraints:

\n " } }, "MasterUserPassword": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The password for the master user. \n The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".\n

\n \n

Constraints: Must contain from 8 to 41 characters.

" + "smithy.api#documentation": "

The password for the master user. \n The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".

\n

Constraints: Must contain from 8 to 41 characters.

" } }, "DBSecurityGroups": { @@ -18655,13 +18652,13 @@ "VpcSecurityGroupIds": { "target": "com.amazonaws.rds#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "

A list of VPC security groups to associate with this DB instance.\n

" + "smithy.api#documentation": "

A list of VPC security groups to associate with this DB instance.

" } }, "AvailabilityZone": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Availability Zone that the DB instance is created in. \n For information about Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.\n

\n

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.\n

\n

\n Example: us-east-1d\n

\n

Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. \n The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.\n

" + "smithy.api#documentation": "

The Availability Zone that the DB instance is created in. \n For information about Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.\n

\n

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

\n

Example: us-east-1d\n

\n

Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. \n The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.

" } }, "DBSubnetGroupName": { @@ -18673,7 +18670,7 @@ "PreferredMaintenanceWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The time range each week during which system maintenance can occur, \n in Universal Coordinated Time (UTC). \n For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.\n

\n\n

Constraints:

\n " + "smithy.api#documentation": "

The time range each week during which system maintenance can occur, \n in Universal Coordinated Time (UTC). \n For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.\n

\n

Constraints:

\n " } }, "DBParameterGroupName": { @@ -18685,149 +18682,149 @@ "BackupRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of days for which automated backups are retained. \n Setting this parameter to a positive number enables backups.\n For more information, see CreateDBInstance.\n

" + "smithy.api#documentation": "

The number of days for which automated backups are retained. \n Setting this parameter to a positive number enables backups.\n For more information, see CreateDBInstance.

" } }, "PreferredBackupWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The time range each day \n during which automated backups are created \n if automated backups are enabled. \n For more information, see Backup window in the Amazon RDS User Guide.\n

\n \n

Constraints:

\n " + "smithy.api#documentation": "

The time range each day \n during which automated backups are created \n if automated backups are enabled. \n For more information, see Backup window in the Amazon RDS User Guide.\n

\n

Constraints:

\n " } }, "Port": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The port number on which the database accepts connections.\n

\n

Type: Integer\n

\n

Valid Values: 1150-65535\n

\n

Default: 3306\n

" + "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

Type: Integer

\n

Valid Values: 1150-65535\n

\n

Default: 3306\n

" } }, "MultiAZ": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is a Multi-AZ deployment. \n If the DB instance is a Multi-AZ deployment, you can't set the AvailabilityZone parameter.\n

" + "smithy.api#documentation": "

A value that indicates whether the DB instance is a Multi-AZ deployment. \n If the DB instance is a Multi-AZ deployment, you can't set the AvailabilityZone parameter.

" } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The version number of the database engine to use.\n Choose the latest minor version of your database engine. \n For information about engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.\n

" + "smithy.api#documentation": "

The version number of the database engine to use.\n Choose the latest minor version of your database engine. \n For information about engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.

" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether minor engine upgrades are applied automatically \n to the DB instance during the maintenance window. By default, minor engine upgrades \n are not applied automatically.\n

" + "smithy.api#documentation": "

A value that indicates whether minor engine upgrades are applied automatically \n to the DB instance during the maintenance window. By default, minor engine upgrades \n are not applied automatically.

" } }, "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The license model for this DB instance.\n Use general-public-license.\n

" + "smithy.api#documentation": "

The license model for this DB instance.\n Use general-public-license.

" } }, "Iops": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) \n to allocate initially for the DB instance.\n For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance \n in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) \n to allocate initially for the DB instance.\n For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance \n in the Amazon RDS User Guide.\n

" } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the option group to associate with this DB instance. \n If this argument is omitted, the default option group for the specified engine is used.\n

" + "smithy.api#documentation": "

The name of the option group to associate with this DB instance. \n If this argument is omitted, the default option group for the specified engine is used.

" } }, "PubliclyAccessible": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is publicly accessible.

\n

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB instance's virtual private cloud (VPC). \n It resolves to the public IP address from outside of the DB instance's VPC. \n Access to the DB instance is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

" + "smithy.api#documentation": "

A value that indicates whether the DB instance is publicly accessible.

\n

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB instance's virtual private cloud (VPC). \n It resolves to the public IP address from outside of the DB instance's VPC. \n Access to the DB instance is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

" } }, "Tags": { "target": "com.amazonaws.rds#TagList", "traits": { - "smithy.api#documentation": "

A list of tags to associate with this DB instance.\n For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide. \n

" + "smithy.api#documentation": "

A list of tags to associate with this DB instance.\n For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.\n

" } }, "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.\n

\n

Valid values: standard | gp2 | io1\n

\n

If you specify io1, \n you must also include a value for the Iops parameter.\n

\n

Default: io1 \n if the Iops parameter is specified; \n otherwise gp2\n

" + "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.

\n

Valid values: standard | gp2 | io1\n

\n

If you specify io1, \n you must also include a value for the Iops parameter.

\n

Default: io1 \n if the Iops parameter is specified; \n otherwise gp2\n

" } }, "StorageEncrypted": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the new DB instance is encrypted or not.\n

" + "smithy.api#documentation": "

A value that indicates whether the new DB instance is encrypted or not.

" } }, "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB instance.\n

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

If the StorageEncrypted parameter is enabled, \n and you do not specify a value for the KmsKeyId parameter, \n then Amazon RDS will use your default KMS key. \n There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.\n

" + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB instance.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

If the StorageEncrypted parameter is enabled, \n and you do not specify a value for the KmsKeyId parameter, \n then Amazon RDS will use your default KMS key. \n There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

" } }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. \n

" + "smithy.api#documentation": "

A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

" } }, "MonitoringInterval": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The interval, in seconds, \n between points when Enhanced Monitoring metrics are collected for the DB instance. \n To disable collecting Enhanced Monitoring metrics, specify 0.\n

\n\n

If MonitoringRoleArn is specified, \n then you must also set MonitoringInterval to a value other than 0.\n

\n\n

Valid Values: 0, 1, 5, 10, 15, 30, 60\n

\n

Default: 0\n

" + "smithy.api#documentation": "

The interval, in seconds, \n between points when Enhanced Monitoring metrics are collected for the DB instance. \n To disable collecting Enhanced Monitoring metrics, specify 0.

\n

If MonitoringRoleArn is specified, \n then you must also set MonitoringInterval to a value other than 0.

\n

Valid Values: 0, 1, 5, 10, 15, 30, 60

\n

Default: 0\n

" } }, "MonitoringRoleArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The ARN for the IAM role that permits RDS \n to send enhanced monitoring metrics to Amazon CloudWatch Logs. \n For example, arn:aws:iam:123456789012:role/emaccess. \n For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring \n in the Amazon RDS User Guide.\n

\n

If MonitoringInterval is set to a value other than 0, \n then you must supply a MonitoringRoleArn value.\n

" + "smithy.api#documentation": "

The ARN for the IAM role that permits RDS \n to send enhanced monitoring metrics to Amazon CloudWatch Logs. \n For example, arn:aws:iam:123456789012:role/emaccess. \n For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring \n in the Amazon RDS User Guide.\n

\n

If MonitoringInterval is set to a value other than 0, \n then you must supply a MonitoringRoleArn value.

" } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n \n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

" } }, "SourceEngine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the engine of your source database.\n

\n \n

Valid Values: mysql\n

", + "smithy.api#documentation": "

The name of the engine of your source database.

\n

Valid Values: \n mysql\n

", "smithy.api#required": {} } }, "SourceEngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The version of the database that the backup files were created from.

\n

MySQL versions 5.6 and 5.7 are supported.\n

\n

Example: 5.6.40\n

", + "smithy.api#documentation": "

The version of the database that the backup files were created from.

\n

MySQL versions 5.6 and 5.7 are supported.

\n

Example: 5.6.40\n

", "smithy.api#required": {} } }, "S3BucketName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of your Amazon S3 bucket \n that contains your database backup file. \n

", + "smithy.api#documentation": "

The name of your Amazon S3 bucket \n that contains your database backup file.

", "smithy.api#required": {} } }, "S3Prefix": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The prefix of your Amazon S3 bucket.\n

" + "smithy.api#documentation": "

The prefix of your Amazon S3 bucket.

" } }, "S3IngestionRoleArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

An Amazon Web Services Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket. \n

", + "smithy.api#documentation": "

An Amazon Web Services Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.

", "smithy.api#required": {} } }, "EnablePerformanceInsights": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable Performance Insights for the DB instance.\n

\n

For more information, see \n Using Amazon Performance Insights in the Amazon Relational Database Service\n User Guide.\n

" + "smithy.api#documentation": "

A value that indicates whether to enable Performance Insights for the DB instance.

\n

For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide..

" } }, "PerformanceInsightsKMSKeyId": { @@ -18839,7 +18836,7 @@ "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

" + "smithy.api#documentation": "

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

" } }, "EnableCloudwatchLogsExports": { @@ -18863,7 +18860,7 @@ "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.\n

" + "smithy.api#documentation": "

A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

" } }, "MaxAllocatedStorage": { @@ -18959,7 +18956,7 @@ } ], "traits": { - "smithy.api#documentation": "

Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.

\n\t

The target database is created with most of the original configuration, but in a\n system-selected Availability Zone, with the default security group, the default subnet\n group, and the default DB parameter group. By default, the new DB instance is created as\n a single-AZ deployment except when the instance is a SQL Server instance that has an\n option group that is associated with mirroring; in this case, the instance becomes a\n mirrored deployment and not a single-AZ deployment.

\n \n

This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime.

\n " + "smithy.api#documentation": "

Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.

\n

The target database is created with most of the original configuration, but in a\n system-selected Availability Zone, with the default security group, the default subnet\n group, and the default DB parameter group. By default, the new DB instance is created as\n a single-AZ deployment except when the instance is a SQL Server instance that has an\n option group that is associated with mirroring; in this case, the instance becomes a\n mirrored deployment and not a single-AZ deployment.

\n \n

This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime.

\n " } }, "com.amazonaws.rds#RestoreDBInstanceToPointInTimeMessage": { @@ -18968,98 +18965,98 @@ "SourceDBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The identifier of the source DB instance from which to restore.

\n

Constraints:

\n " + "smithy.api#documentation": "

The identifier of the source DB instance from which to restore.

\n

Constraints:

\n " } }, "TargetDBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the new DB instance to be created.

\n

Constraints:

\n ", + "smithy.api#documentation": "

The name of the new DB instance to be created.

\n

Constraints:

\n ", "smithy.api#required": {} } }, "RestoreTime": { "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

The date and time to restore from.

\n

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

\n

Constraints:

\n \n

Example: 2009-09-07T23:45:00Z\n

" + "smithy.api#documentation": "

The date and time to restore from.

\n

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

\n

Constraints:

\n \n

Example: 2009-09-07T23:45:00Z\n

" } }, "UseLatestRestorableTime": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

\n A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance \n isn't restored from the latest backup time.\n

\n

Constraints: Can't be specified if the RestoreTime parameter is provided.

" + "smithy.api#documentation": "

A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance \n isn't restored from the latest backup time.

\n

Constraints: Can't be specified if the RestoreTime parameter is provided.

" } }, "DBInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the Amazon RDS DB instance, for example\n db.m4.large. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines. For the full list of DB instance classes, and\n availability for your engine, see DB Instance\n Class in the Amazon RDS User Guide.\n

\n

Default: The same DBInstanceClass as the original DB instance.

" + "smithy.api#documentation": "

The compute and memory capacity of the Amazon RDS DB instance, for example\n db.m4.large. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines. For the full list of DB instance classes, and\n availability for your engine, see DB Instance\n Class in the Amazon RDS User Guide.

\n

Default: The same DBInstanceClass as the original DB instance.

" } }, "Port": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

Constraints: Value must be 1150-65535\n

\n

Default: The same port as the original DB instance.

" + "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

Constraints: Value must be 1150-65535\n

\n

Default: The same port as the original DB instance.

" } }, "AvailabilityZone": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Availability Zone (AZ) where the DB instance will be created.

\n

Default: A random, system-chosen Availability Zone.

\n

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

\n

Example: us-east-1a\n

" + "smithy.api#documentation": "

The Availability Zone (AZ) where the DB instance will be created.

\n

Default: A random, system-chosen Availability Zone.

\n

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

\n

Example: us-east-1a\n

" } }, "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The DB subnet group name to use for the new instance.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mydbsubnetgroup\n

" + "smithy.api#documentation": "

The DB subnet group name to use for the new instance.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mydbsubnetgroup\n

" } }, "MultiAZ": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is a Multi-AZ deployment.

\n

This setting doesn't apply to RDS Custom.

\n

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a \n Multi-AZ deployment.

" + "smithy.api#documentation": "

A value that indicates whether the DB instance is a Multi-AZ deployment.

\n

This setting doesn't apply to RDS Custom.

\n

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a \n Multi-AZ deployment.

" } }, "PubliclyAccessible": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

" + "smithy.api#documentation": "

A value that indicates whether the DB instance is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether minor version upgrades are applied automatically to the \n DB instance during the maintenance window.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

A value that indicates whether minor version upgrades are applied automatically to the \n DB instance during the maintenance window.

\n

This setting doesn't apply to RDS Custom.

" } }, "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

License model information for the restored DB instance.

\n

This setting doesn't apply to RDS Custom.

\n

Default: Same as source.

\n

\n Valid values: license-included | bring-your-own-license | general-public-license\n

" + "smithy.api#documentation": "

License model information for the restored DB instance.

\n

This setting doesn't apply to RDS Custom.

\n

Default: Same as source.

\n

Valid values: license-included | bring-your-own-license | general-public-license\n

" } }, "DBName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The database name for the restored DB instance.

\n \n

This parameter isn't supported for the MySQL or MariaDB engines. It also doesn't apply to RDS Custom.

\n " + "smithy.api#documentation": "

The database name for the restored DB instance.

\n \n

This parameter isn't supported for the MySQL or MariaDB engines. It also doesn't apply to RDS Custom.

\n " } }, "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The database engine to use for the new instance.

\n

This setting doesn't apply to RDS Custom.

\n

Default: The same as source

\n

Constraint: Must be compatible with the engine of the source

\n\n

Valid Values:

\n \n " + "smithy.api#documentation": "

The database engine to use for the new instance.

\n

This setting doesn't apply to RDS Custom.

\n

Default: The same as source

\n

Constraint: Must be compatible with the engine of the source

\n

Valid Values:

\n " } }, "Iops": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

\n

Constraints: Must be an integer greater than 1000.

\n

\n SQL Server\n

\n

Setting the IOPS value for the SQL Server database engine isn't supported.

" + "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

\n

Constraints: Must be an integer greater than 1000.

\n

\n SQL Server\n

\n

Setting the IOPS value for the SQL Server database engine isn't supported.

" } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the option group to be used for the restored DB instance.

\n \n

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an \n option group, and that option group can't be removed from a DB instance after it is associated with a DB instance

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The name of the option group to be used for the restored DB instance.

\n \n \n

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an \n option group, and that option group can't be removed from a DB instance after it is associated with a DB instance

\n

This setting doesn't apply to RDS Custom.

" } }, "CopyTagsToSnapshot": { @@ -19074,43 +19071,43 @@ "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.

\n

\n Valid values: standard | gp2 | io1\n

\n

\n If you specify io1, you must also include a value for the\n Iops parameter.\n

\n

\n Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

" + "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.

\n

Valid values: standard | gp2 | io1\n

\n

If you specify io1, you must also include a value for the\n Iops parameter.

\n

Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

" } }, "TdeCredentialArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The ARN from the key store with which to associate the instance for TDE encryption.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The ARN from the key store with which to associate the instance for TDE encryption.

\n

This setting doesn't apply to RDS Custom.

" } }, "TdeCredentialPassword": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The password for the given ARN from the key store in order to access the device.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The password for the given ARN from the key store in order to access the device.

\n

This setting doesn't apply to RDS Custom.

" } }, "VpcSecurityGroupIds": { "target": "com.amazonaws.rds#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "

\n A list of EC2 VPC security groups to associate with this DB instance.\n

\n

\n Default: The default EC2 VPC security group for the DB subnet group's VPC.\n

" + "smithy.api#documentation": "

A list of EC2 VPC security groups to associate with this DB instance.

\n

Default: The default EC2 VPC security group for the DB subnet group's VPC.

" } }, "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specify the Active Directory directory ID to restore the DB instance in.\n Create the domain before running this command. Currently, you can create only the MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.

\n

This setting doesn't apply to RDS Custom.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

" + "smithy.api#documentation": "

Specify the Active Directory directory ID to restore the DB instance in.\n Create the domain before running this command. Currently, you can create only the MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.

\n

This setting doesn't apply to RDS Custom.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

" } }, "DomainIAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

\n

This setting doesn't apply to RDS Custom.

" } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n \n

This setting doesn't apply to RDS Custom.

\n \n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n

This setting doesn't apply to RDS Custom.

\n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

" } }, "EnableCloudwatchLogsExports": { @@ -19140,7 +19137,7 @@ "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.\n

" + "smithy.api#documentation": "

A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

" } }, "SourceDbiResourceId": { @@ -19152,7 +19149,7 @@ "MaxAllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" } }, "SourceDBInstanceAutomatedBackupsArn": { @@ -19170,7 +19167,7 @@ "CustomIamInstanceProfile": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n \n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon Relational Database Service\n User Guide.

\n

This setting is required for RDS Custom.

" + "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n \n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

\n

This setting is required for RDS Custom.

" } }, "BackupTarget": { @@ -19248,25 +19245,25 @@ "CIDRIP": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n The IP range to revoke access from. \n Must be a valid CIDR range. If CIDRIP is specified, \n EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId\n can't be provided.\n

" + "smithy.api#documentation": "

The IP range to revoke access from. \n Must be a valid CIDR range. If CIDRIP is specified, \n EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId\n can't be provided.

" } }, "EC2SecurityGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n The name of the EC2 security group to revoke access from.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.\n

" + "smithy.api#documentation": "

The name of the EC2 security group to revoke access from.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" } }, "EC2SecurityGroupId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n The id of the EC2 security group to revoke access from.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.\n

" + "smithy.api#documentation": "

The id of the EC2 security group to revoke access from.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" } }, "EC2SecurityGroupOwnerId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n The Amazon Web Services account number of the owner of the EC2 security group\n specified in the EC2SecurityGroupName parameter.\n The Amazon Web Services access key ID isn't an acceptable value.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.\n

" + "smithy.api#documentation": "

The Amazon Web Services account number of the owner of the EC2 security group\n specified in the EC2SecurityGroupName parameter.\n The Amazon Web Services access key ID isn't an acceptable value.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" } } }, @@ -19351,7 +19348,7 @@ "AutoPause": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode.\n A DB cluster can be paused only when it's idle (it has no connections).

\n \n

If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot.\n In this case, the DB cluster is restored when there is a request to connect to it.

\n " + "smithy.api#documentation": "

A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode.\n A DB cluster can be paused only when it's idle (it has no connections).

\n \n

If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot.\n In this case, the DB cluster is restored when there is a request to connect to it.

\n " } }, "SecondsUntilAutoPause": { @@ -19363,18 +19360,18 @@ "TimeoutAction": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.

\n

\n ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.

\n

\n RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.

\n \n

If you specify ForceApplyCapacityChange, connections that\n prevent Aurora Serverless from finding a scaling point might be dropped.

\n \n

For more information, see \n Autoscaling for Aurora Serverless in the Amazon Aurora User Guide.

" + "smithy.api#documentation": "

The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.

\n

\n ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.

\n

\n RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.

\n \n

If you specify ForceApplyCapacityChange, connections that\n prevent Aurora Serverless v1 from finding a scaling point might be dropped.

\n \n

For more information, see \n Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.

" } }, "SecondsBeforeTimeout": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, that Aurora Serverless tries to find a scaling point\n to perform seamless scaling before enforcing the timeout action. The default is 300.

\n

Specify a value between 60 and 600 seconds.

" + "smithy.api#documentation": "

The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point\n to perform seamless scaling before enforcing the timeout action. The default is 300.

\n

Specify a value between 60 and 600 seconds.

" } } }, "traits": { - "smithy.api#documentation": "

Contains the scaling configuration of an Aurora Serverless DB cluster.

\n

For more information, see Using Amazon Aurora Serverless in the\n Amazon Aurora User Guide.

" + "smithy.api#documentation": "

Contains the scaling configuration of an Aurora Serverless v1 DB cluster.

\n

For more information, see Using Amazon Aurora Serverless v1 in the\n Amazon Aurora User Guide.

" } }, "com.amazonaws.rds#ScalingConfigurationInfo": { @@ -19395,7 +19392,7 @@ "AutoPause": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether automatic pause is allowed for the Aurora DB cluster\n in serverless DB engine mode.

\n

When the value is set to false for an Aurora Serverless DB cluster, the DB cluster automatically resumes.

" + "smithy.api#documentation": "

A value that indicates whether automatic pause is allowed for the Aurora DB cluster\n in serverless DB engine mode.

\n

When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.

" } }, "SecondsUntilAutoPause": { @@ -19407,7 +19404,7 @@ "TimeoutAction": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The action that occurs when Aurora times out while attempting to change the capacity of an\n Aurora Serverless cluster. The value is either ForceApplyCapacityChange or\n RollbackCapacityChange.

\n

\n ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.

\n

\n RollbackCapacityChange ignores the capacity change if a scaling point isn't found in the timeout period.

" + "smithy.api#documentation": "

The action that occurs when Aurora times out while attempting to change the capacity of an\n Aurora Serverless v1 cluster. The value is either ForceApplyCapacityChange or\n RollbackCapacityChange.

\n

\n ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.

\n

\n RollbackCapacityChange ignores the capacity change if a scaling point isn't found in the timeout period.

" } }, "SecondsBeforeTimeout": { @@ -19418,7 +19415,7 @@ } }, "traits": { - "smithy.api#documentation": "

Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.

\n

For more information, see Using Amazon Aurora Serverless in the\n Amazon Aurora User Guide.

" + "smithy.api#documentation": "

Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.

\n

For more information, see Using Amazon Aurora Serverless v1 in the\n Amazon Aurora User Guide.

" } }, "com.amazonaws.rds#SharedSnapshotQuotaExceededFault": { @@ -19528,13 +19525,13 @@ "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" } }, "SourceRegions": { "target": "com.amazonaws.rds#SourceRegionList", "traits": { - "smithy.api#documentation": "

A list of SourceRegion instances that contains each source Amazon Web Services Region that the\n current Amazon Web Services Region can get a read replica or a DB snapshot from.

" + "smithy.api#documentation": "

A list of SourceRegion instances that contains each source Amazon Web Services Region that the\n current Amazon Web Services Region can get a read replica or a DB snapshot from.

" } } }, @@ -19626,7 +19623,7 @@ "Mode": { "target": "com.amazonaws.rds#ActivityStreamMode", "traits": { - "smithy.api#documentation": "

Specifies the mode of the database activity stream.\n Database events such as a change or access generate an activity stream event.\n The database session can handle these events either synchronously or asynchronously.\n

", + "smithy.api#documentation": "

Specifies the mode of the database activity stream.\n Database events such as a change or access generate an activity stream event.\n The database session can handle these events either synchronously or asynchronously.

", "smithy.api#required": {} } }, @@ -19712,7 +19709,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster\n CLI command, or the StopDBCluster action.

\n \n

For more information, see \n \n Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.\n

\n \n

This action only applies to Aurora DB clusters.

\n " + "smithy.api#documentation": "

Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster\n CLI command, or the StopDBCluster action.

\n

For more information, see \n \n Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.

\n \n

This action only applies to Aurora DB clusters.

\n " } }, "com.amazonaws.rds#StartDBClusterMessage": { @@ -19779,7 +19776,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance action.\n

\n \n

For more information, see \n \n Starting an Amazon RDS DB instance That Was Previously Stopped in the \n Amazon RDS User Guide.\n

\n \n \n

\n This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.\n For Aurora DB clusters, use StartDBCluster instead.\n

\n " + "smithy.api#documentation": "

Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance action.

\n

For more information, see \n \n Starting an Amazon RDS DB instance That Was Previously Stopped in the \n Amazon RDS User Guide.\n

\n \n

This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.\n For Aurora DB clusters, use StartDBCluster instead.

\n " } }, "com.amazonaws.rds#StartDBInstanceAutomatedBackupsReplication": { @@ -19855,7 +19852,7 @@ "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n The user-supplied instance identifier. \n

", + "smithy.api#documentation": "

The user-supplied instance identifier.

", "smithy.api#required": {} } } @@ -19907,7 +19904,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts an export of a snapshot to Amazon S3. \n The provided IAM role must have access to the S3 bucket. \n

\n

This command doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

Starts an export of a snapshot to Amazon S3. \n The provided IAM role must have access to the S3 bucket.

\n

This command doesn't apply to RDS Custom.

" } }, "com.amazonaws.rds#StartExportTaskMessage": { @@ -19916,7 +19913,7 @@ "ExportTaskIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

A unique identifier for the snapshot export task. This ID isn't an identifier for\n the Amazon S3 bucket where the snapshot is to be exported to.

", + "smithy.api#documentation": "

A unique identifier for the snapshot export task. This ID isn't an identifier for\n the Amazon S3 bucket where the snapshot is to be exported to.

", "smithy.api#required": {} } }, @@ -19937,14 +19934,14 @@ "IamRoleArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the IAM role to use for writing to the Amazon S3 bucket \n when exporting a snapshot.

", + "smithy.api#documentation": "

The name of the IAM role to use for writing to the Amazon S3 bucket \n when exporting a snapshot.

", "smithy.api#required": {} } }, "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services KMS key to use to encrypt the snapshot exported to Amazon S3. The Amazon Web Services KMS \n key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. \n The caller of this operation must be authorized to execute the following operations. \n These can be set in the Amazon Web Services KMS key policy:

\n ", + "smithy.api#documentation": "

The ID of the Amazon Web Services KMS key to use to encrypt the snapshot exported to Amazon S3. The Amazon Web Services KMS \n key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. \n The caller of this operation must be authorized to execute the following operations. \n These can be set in the Amazon Web Services KMS key policy:

\n ", "smithy.api#required": {} } }, @@ -19957,7 +19954,7 @@ "ExportOnly": { "target": "com.amazonaws.rds#StringList", "traits": { - "smithy.api#documentation": "

The data to be exported from the snapshot. \n If this parameter is not provided, all the snapshot data is exported.\n Valid values are the following:

\n " + "smithy.api#documentation": "

The data to be exported from the snapshot. \n If this parameter is not provided, all the snapshot data is exported.\n Valid values are the following:

\n " } } } @@ -19997,7 +19994,7 @@ "ResourceArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the DB cluster for the database activity stream.\n For example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.\n

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the DB cluster for the database activity stream.\n For example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.

", "smithy.api#required": {} } }, @@ -20052,7 +20049,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's\n metadata, including its endpoints and DB parameter groups. Aurora also\n retains the transaction logs so you can do a point-in-time restore if necessary.\n

\n \n

For more information, see \n \n Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.\n

\n \n

This action only applies to Aurora DB clusters.

\n " + "smithy.api#documentation": "

Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's\n metadata, including its endpoints and DB parameter groups. Aurora also\n retains the transaction logs so you can do a point-in-time restore if necessary.

\n

For more information, see \n \n Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.

\n \n

This action only applies to Aurora DB clusters.

\n " } }, "com.amazonaws.rds#StopDBClusterMessage": { @@ -20101,7 +20098,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, \n DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if \n necessary.\n

\n \n

For more information, see \n \n Stopping an Amazon RDS DB Instance Temporarily in the \n Amazon RDS User Guide.\n

\n \n \n

\n This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.\n For Aurora clusters, use StopDBCluster instead.\n

\n " + "smithy.api#documentation": "

Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, \n DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if \n necessary.

\n

For more information, see \n \n Stopping an Amazon RDS DB Instance Temporarily in the \n Amazon RDS User Guide.\n

\n \n

This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.\n For Aurora clusters, use StopDBCluster instead.

\n " } }, "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplication": { @@ -20150,14 +20147,14 @@ "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n The user-supplied instance identifier.\n

", + "smithy.api#documentation": "

The user-supplied instance identifier.

", "smithy.api#required": {} } }, "DBSnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.\n

" + "smithy.api#documentation": "

The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.

" } } } @@ -20199,7 +20196,7 @@ "code": "StorageTypeNotSupported", "httpResponseCode": 400 }, - "smithy.api#documentation": "

Storage of the StorageType specified can't be associated\n with the DB instance.

", + "smithy.api#documentation": "

Storage of the StorageType specified can't be associated\n with the DB instance.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -20255,7 +20252,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n This data type is used as a response element for the DescribeDBSubnetGroups operation.\n

" + "smithy.api#documentation": "

This data type is used as a response element for the DescribeDBSubnetGroups operation.

" } }, "com.amazonaws.rds#SubnetAlreadyInUse": { @@ -20394,7 +20391,7 @@ } }, "traits": { - "smithy.api#documentation": "

A list of tags.\n For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide. \n

" + "smithy.api#documentation": "

A list of tags.\n For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.\n

" } }, "com.amazonaws.rds#TagListMessage": { @@ -20403,7 +20400,7 @@ "TagList": { "target": "com.amazonaws.rds#TagList", "traits": { - "smithy.api#documentation": "

List of tags returned by the ListTagsForResource operation.

" + "smithy.api#documentation": "

List of tags returned by the ListTagsForResource operation.

" } } }, @@ -20423,7 +20420,7 @@ "State": { "target": "com.amazonaws.rds#TargetState", "traits": { - "smithy.api#documentation": "

The current state of the connection health lifecycle for the RDS Proxy target.\n The following is a typical lifecycle example for the states of an RDS Proxy target:\n

\n

\n registering > unavailable > available > unavailable > available\n

" + "smithy.api#documentation": "

The current state of the connection health lifecycle for the RDS Proxy target.\n The following is a typical lifecycle example for the states of an RDS Proxy target:

\n

\n registering > unavailable > available > unavailable > available\n

" } }, "Reason": { @@ -20544,7 +20541,7 @@ } }, "traits": { - "smithy.api#documentation": "

A time zone associated with a \n DBInstance \n or a DBSnapshot.\n This data type is an element in the response to \n the DescribeDBInstances, \n the DescribeDBSnapshots,\n and the DescribeDBEngineVersions\n actions.\n

" + "smithy.api#documentation": "

A time zone associated with a \n DBInstance \n or a DBSnapshot.\n This data type is an element in the response to \n the DescribeDBInstances, \n the DescribeDBSnapshots,\n and the DescribeDBEngineVersions\n actions.

" } }, "com.amazonaws.rds#UpgradeTarget": { @@ -20703,18 +20700,18 @@ "Storage": { "target": "com.amazonaws.rds#ValidStorageOptionsList", "traits": { - "smithy.api#documentation": "

Valid storage options for your DB instance.\n

" + "smithy.api#documentation": "

Valid storage options for your DB instance.

" } }, "ValidProcessorFeatures": { "target": "com.amazonaws.rds#AvailableProcessorFeatureList", "traits": { - "smithy.api#documentation": "

Valid processor features for your DB instance.\n

" + "smithy.api#documentation": "

Valid processor features for your DB instance.

" } } }, "traits": { - "smithy.api#documentation": "

Information about valid modifications that you can make to your DB instance.\n Contains the result of a successful call to the \n DescribeValidDBInstanceModifications action.\n You can use this information when you call\n ModifyDBInstance.\n

" + "smithy.api#documentation": "

Information about valid modifications that you can make to your DB instance.\n Contains the result of a successful call to the \n DescribeValidDBInstanceModifications action.\n You can use this information when you call\n ModifyDBInstance.

" } }, "com.amazonaws.rds#ValidStorageOptions": { @@ -20723,25 +20720,25 @@ "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The valid storage types for your DB instance.\n For example, gp2, io1.\n

" + "smithy.api#documentation": "

The valid storage types for your DB instance.\n For example, gp2, io1.

" } }, "StorageSize": { "target": "com.amazonaws.rds#RangeList", "traits": { - "smithy.api#documentation": "

The valid range of storage in gibibytes (GiB).\n For example, 100 to 16384. \n

" + "smithy.api#documentation": "

The valid range of storage in gibibytes (GiB).\n For example, 100 to 16384.

" } }, "ProvisionedIops": { "target": "com.amazonaws.rds#RangeList", "traits": { - "smithy.api#documentation": "

The valid range of provisioned IOPS.\n For example, 1000-20000.\n

" + "smithy.api#documentation": "

The valid range of provisioned IOPS.\n For example, 1000-20000.

" } }, "IopsToStorageRatio": { "target": "com.amazonaws.rds#DoubleRangeList", "traits": { - "smithy.api#documentation": "

The valid range of Provisioned IOPS to gibibytes of storage multiplier.\n For example, 3-10,\n which means that provisioned IOPS can be between 3 and 10 times storage.\n

" + "smithy.api#documentation": "

The valid range of Provisioned IOPS to gibibytes of storage multiplier.\n For example, 3-10,\n which means that provisioned IOPS can be between 3 and 10 times storage.

" } }, "SupportsStorageAutoscaling": { @@ -20752,7 +20749,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information about valid modifications that you can make to your DB instance.\n Contains the result of a successful call to the \n DescribeValidDBInstanceModifications action.\n

" + "smithy.api#documentation": "

Information about valid modifications that you can make to your DB instance.\n Contains the result of a successful call to the \n DescribeValidDBInstanceModifications action.

" } }, "com.amazonaws.rds#ValidStorageOptionsList": { diff --git a/codegen/sdk-codegen/aws-models/robomaker.json b/codegen/sdk-codegen/aws-models/robomaker.json index 66701a5215130..30e1689bcaf1b 100644 --- a/codegen/sdk-codegen/aws-models/robomaker.json +++ b/codegen/sdk-codegen/aws-models/robomaker.json @@ -2173,7 +2173,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 5 + "max": 6 } } }, @@ -4190,7 +4190,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 16 + "max": 20 } } }, @@ -5584,8 +5584,10 @@ "recordAllRosTopics": { "target": "com.amazonaws.robomaker#BoxedBoolean", "traits": { - "smithy.api#documentation": "

A boolean indicating whether to record all ROS topics.

", - "smithy.api#required": {} + "smithy.api#deprecated": { + "message": "AWS RoboMaker is ending support for ROS software suite. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/software-support-policy.html." + }, + "smithy.api#documentation": "

A boolean indicating whether to record all ROS topics.

\n \n

This API is no longer supported and will throw an error if used.

\n " } } }, @@ -6129,7 +6131,10 @@ "useDefaultUploadConfigurations": { "target": "com.amazonaws.robomaker#BoxedBoolean", "traits": { - "smithy.api#documentation": "

A Boolean indicating whether to use default upload configurations. By default,\n .ros and .gazebo files are uploaded when the application\n terminates and all ROS topics will be recorded.

\n

If you set this value, you must specify an outputLocation.

" + "smithy.api#deprecated": { + "message": "AWS RoboMaker is ending support for ROS software suite. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/software-support-policy.html." + }, + "smithy.api#documentation": "

A Boolean indicating whether to use default upload configurations. By default,\n .ros and .gazebo files are uploaded when the application\n terminates and all ROS topics will be recorded.

\n

If you set this value, you must specify an outputLocation.

\n \n

This API is no longer supported and will throw an error if used.

\n " } }, "tools": { @@ -6141,7 +6146,10 @@ "useDefaultTools": { "target": "com.amazonaws.robomaker#BoxedBoolean", "traits": { - "smithy.api#documentation": "

A Boolean indicating whether to use default robot application tools. The default tools\n are rviz, rqt, terminal and rosbag record. The default is False.

" + "smithy.api#deprecated": { + "message": "AWS RoboMaker is ending support for ROS software suite. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/software-support-policy.html." + }, + "smithy.api#documentation": "

A Boolean indicating whether to use default robot application tools. The default tools\n are rviz, rqt, terminal and rosbag record. The default is False.

\n \n

This API is no longer supported and will throw an error if used.

\n " } } }, @@ -6585,7 +6593,10 @@ "useDefaultUploadConfigurations": { "target": "com.amazonaws.robomaker#BoxedBoolean", "traits": { - "smithy.api#documentation": "

A Boolean indicating whether to use default upload configurations. By default,\n .ros and .gazebo files are uploaded when the application\n terminates and all ROS topics will be recorded.

\n

If you set this value, you must specify an outputLocation.

" + "smithy.api#deprecated": { + "message": "AWS RoboMaker is ending support for ROS software suite. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/software-support-policy.html." + }, + "smithy.api#documentation": "

A Boolean indicating whether to use default upload configurations. By default,\n .ros and .gazebo files are uploaded when the application\n terminates and all ROS topics will be recorded.

\n

If you set this value, you must specify an outputLocation.

\n \n

This API is no longer supported and will throw an error if used.

\n " } }, "tools": { @@ -6597,7 +6608,10 @@ "useDefaultTools": { "target": "com.amazonaws.robomaker#BoxedBoolean", "traits": { - "smithy.api#documentation": "

A Boolean indicating whether to use default simulation application tools. The default\n tools are rviz, rqt, terminal and rosbag record. The default is False.

" + "smithy.api#deprecated": { + "message": "AWS RoboMaker is ending support for ROS software suite. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/software-support-policy.html." + }, + "smithy.api#documentation": "

A Boolean indicating whether to use default simulation application tools. The default\n tools are rviz, rqt, terminal and rosbag record. The default is False.

\n \n

This API is no longer supported and will throw an error if used.

\n " } } }, @@ -8600,6 +8614,9 @@ "traits": { "smithy.api#documentation": "

A list of worlds.

" } + }, + "outputLocation": { + "target": "com.amazonaws.robomaker#OutputLocation" } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/s3outposts.json b/codegen/sdk-codegen/aws-models/s3outposts.json index 836d8d4c0bf93..02269109758ee 100644 --- a/codegen/sdk-codegen/aws-models/s3outposts.json +++ b/codegen/sdk-codegen/aws-models/s3outposts.json @@ -84,7 +84,7 @@ } ], "traits": { - "smithy.api#documentation": "

Amazon S3 on Outposts Access Points simplify managing data access at scale for shared datasets in S3 on Outposts. \n S3 on Outposts uses endpoints to connect to Outposts buckets so that you can perform actions within your \n virtual private cloud (VPC). For more information, see \n Accessing S3 on Outposts using VPC only access points.

\n

This action creates an endpoint and associates it with the specified Outposts.

\n \n

It can take up to 5 minutes for this action to complete.

\n \n

\n

Related actions include:

\n ", + "smithy.api#documentation": "

Creates an endpoint and associates it with the specified Outpost.

\n \n

It can take up to 5 minutes for this action to finish.

\n \n

\n

Related actions include:

\n ", "smithy.api#http": { "method": "POST", "uri": "/S3Outposts/CreateEndpoint", @@ -98,14 +98,14 @@ "OutpostId": { "target": "com.amazonaws.s3outposts#OutpostId", "traits": { - "smithy.api#documentation": "

The ID of the AWS Outposts.

", + "smithy.api#documentation": "

The ID of the Outposts.

", "smithy.api#required": {} } }, "SubnetId": { "target": "com.amazonaws.s3outposts#SubnetId", "traits": { - "smithy.api#documentation": "

The ID of the subnet in the selected VPC. The endpoint subnet \n must belong to the Outpost that has the Amazon S3 on Outposts provisioned.

", + "smithy.api#documentation": "

The ID of the subnet in the selected VPC. The endpoint subnet must belong to the Outpost\n that has Amazon S3 on Outposts provisioned.

", "smithy.api#required": {} } }, @@ -119,13 +119,13 @@ "AccessType": { "target": "com.amazonaws.s3outposts#EndpointAccessType", "traits": { - "smithy.api#documentation": "

The type of access for the on-premise network connectivity for the \n Outpost endpoint. To access the endpoint from an on-premises network, you must \n specify the access type and provide the customer owned IPv4 pool.

" + "smithy.api#documentation": "

The type of access for the network connectivity for the Amazon S3 on Outposts endpoint. To use\n the Amazon Web Services VPC, choose Private. To use the endpoint with an on-premises\n network, choose CustomerOwnedIp. If you choose\n CustomerOwnedIp, you must also provide the customer-owned IP address\n pool (CoIP pool).

\n \n

\n Private is the default access type value.

\n " } }, "CustomerOwnedIpv4Pool": { "target": "com.amazonaws.s3outposts#CustomerOwnedIpv4Pool", "traits": { - "smithy.api#documentation": "

The ID of the customer-owned IPv4 pool for the endpoint. \n IP addresses will be allocated from this pool for the endpoint.

" + "smithy.api#documentation": "

The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint. IP addresses\n are allocated from this pool for the endpoint.

" } } } @@ -170,7 +170,7 @@ } ], "traits": { - "smithy.api#documentation": "

Amazon S3 on Outposts Access Points simplify managing data access at scale for shared datasets in S3 on Outposts. \n S3 on Outposts uses endpoints to connect to Outposts buckets so that you can perform actions within your \n virtual private cloud (VPC). For more information, see \n Accessing S3 on Outposts using VPC only access points.

\n

This action deletes an endpoint.

\n \n

It can take up to 5 minutes for this action to complete.

\n \n

\n

Related actions include:

\n ", + "smithy.api#documentation": "

Deletes an endpoint.

\n \n

It can take up to 5 minutes for this action to finish.

\n \n

\n

Related actions include:

\n ", "smithy.api#http": { "method": "DELETE", "uri": "/S3Outposts/DeleteEndpoint", @@ -192,7 +192,7 @@ "OutpostId": { "target": "com.amazonaws.s3outposts#OutpostId", "traits": { - "smithy.api#documentation": "

The ID of the AWS Outposts.

", + "smithy.api#documentation": "

The ID of the Outposts.

", "smithy.api#httpQuery": "outpostId", "smithy.api#required": {} } @@ -211,7 +211,7 @@ "OutpostsId": { "target": "com.amazonaws.s3outposts#OutpostId", "traits": { - "smithy.api#documentation": "

The ID of the AWS Outposts.

" + "smithy.api#documentation": "

The ID of the Outposts.

" } }, "CidrBlock": { @@ -259,18 +259,18 @@ "AccessType": { "target": "com.amazonaws.s3outposts#EndpointAccessType", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The type of connectivity used to access the Amazon S3 on Outposts endpoint.

" } }, "CustomerOwnedIpv4Pool": { "target": "com.amazonaws.s3outposts#CustomerOwnedIpv4Pool", "traits": { - "smithy.api#documentation": "

The ID of the customer-owned IPv4 pool used for the endpoint.

" + "smithy.api#documentation": "

The ID of the customer-owned IPv4 address pool used for the endpoint.

" } } }, "traits": { - "smithy.api#documentation": "

Amazon S3 on Outposts Access Points simplify managing data access at scale for shared datasets in S3 on Outposts. \n S3 on Outposts uses endpoints to connect to Outposts buckets so that you can perform actions within your \n virtual private cloud (VPC). For more information, see \n Accessing S3 on Outposts using VPC only access points.

" + "smithy.api#documentation": "

Amazon S3 on Outposts Access Points simplify managing data access at scale for shared datasets in S3 on Outposts. \n S3 on Outposts uses endpoints to connect to Outposts buckets so that you can perform actions within your \n virtual private cloud (VPC). For more information, see \n Accessing S3 on Outposts using VPC-only access points in the Amazon Simple Storage Service User Guide.

" } }, "com.amazonaws.s3outposts#EndpointAccessType": { @@ -364,7 +364,7 @@ } ], "traits": { - "smithy.api#documentation": "

Amazon S3 on Outposts Access Points simplify managing data access at scale for shared datasets in S3 on Outposts. \n S3 on Outposts uses endpoints to connect to Outposts buckets so that you can perform actions within your \n virtual private cloud (VPC). For more information, see \n Accessing S3 on Outposts using VPC only access points.

\n

This action lists endpoints associated with the Outposts.\n

\n

\n

Related actions include:

\n ", + "smithy.api#documentation": "

Lists endpoints associated with the specified Outpost.

\n

Related actions include:

\n ", "smithy.api#http": { "method": "GET", "uri": "/S3Outposts/ListEndpoints", @@ -384,14 +384,14 @@ "NextToken": { "target": "com.amazonaws.s3outposts#NextToken", "traits": { - "smithy.api#documentation": "

The next endpoint requested in the list.

", + "smithy.api#documentation": "

If a previous response from this operation included a NextToken value, \n provide that value here to retrieve the next page of results.

", "smithy.api#httpQuery": "nextToken" } }, "MaxResults": { "target": "com.amazonaws.s3outposts#MaxResults", "traits": { - "smithy.api#documentation": "

The max number of endpoints that can be returned on the request.

", + "smithy.api#documentation": "

The maximum number of endpoints that will be returned in the response.

", "smithy.api#httpQuery": "maxResults" } } @@ -403,13 +403,94 @@ "Endpoints": { "target": "com.amazonaws.s3outposts#Endpoints", "traits": { - "smithy.api#documentation": "

Returns an array of endpoints associated with AWS Outposts.

" + "smithy.api#documentation": "

The list of endpoints associated with the specified Outpost.

" } }, "NextToken": { "target": "com.amazonaws.s3outposts#NextToken", "traits": { - "smithy.api#documentation": "

The next endpoint returned in the list.

" + "smithy.api#documentation": "

If the number of endpoints associated with the specified Outpost exceeds MaxResults, \n you can include this value in subsequent calls to this operation to retrieve more results.

" + } + } + } + }, + "com.amazonaws.s3outposts#ListSharedEndpoints": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3outposts#ListSharedEndpointsRequest" + }, + "output": { + "target": "com.amazonaws.s3outposts#ListSharedEndpointsResult" + }, + "errors": [ + { + "target": "com.amazonaws.s3outposts#AccessDeniedException" + }, + { + "target": "com.amazonaws.s3outposts#InternalServerException" + }, + { + "target": "com.amazonaws.s3outposts#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.s3outposts#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all endpoints associated with an Outpost that has been shared by Amazon Web Services Resource Access Manager (RAM).

\n

Related actions include:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/S3Outposts/ListSharedEndpoints", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Endpoints", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.s3outposts#ListSharedEndpointsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.s3outposts#NextToken", + "traits": { + "smithy.api#documentation": "

If a previous response from this operation included a NextToken value, you\n can provide that value here to retrieve the next page of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.s3outposts#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of endpoints that will be returned in the response.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "OutpostId": { + "target": "com.amazonaws.s3outposts#OutpostId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services Outpost.

", + "smithy.api#httpQuery": "outpostId", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.s3outposts#ListSharedEndpointsResult": { + "type": "structure", + "members": { + "Endpoints": { + "target": "com.amazonaws.s3outposts#Endpoints", + "traits": { + "smithy.api#documentation": "

The list of endpoints associated with the specified Outpost that have been shared by Amazon Web Services Resource Access Manager (RAM).

" + } + }, + "NextToken": { + "target": "com.amazonaws.s3outposts#NextToken", + "traits": { + "smithy.api#documentation": "

If the number of endpoints associated with the specified Outpost exceeds MaxResults, \n you can include this value in subsequent calls to this operation to retrieve more results.

" } } } @@ -477,18 +558,6 @@ }, "com.amazonaws.s3outposts#S3Outposts": { "type": "service", - "version": "2017-07-25", - "operations": [ - { - "target": "com.amazonaws.s3outposts#CreateEndpoint" - }, - { - "target": "com.amazonaws.s3outposts#DeleteEndpoint" - }, - { - "target": "com.amazonaws.s3outposts#ListEndpoints" - } - ], "traits": { "aws.api#service": { "sdkId": "S3Outposts", @@ -503,7 +572,22 @@ "aws.protocols#restJson1": {}, "smithy.api#documentation": "

Amazon S3 on Outposts provides access to S3 on Outposts operations.

", "smithy.api#title": "Amazon S3 on Outposts" - } + }, + "version": "2017-07-25", + "operations": [ + { + "target": "com.amazonaws.s3outposts#CreateEndpoint" + }, + { + "target": "com.amazonaws.s3outposts#DeleteEndpoint" + }, + { + "target": "com.amazonaws.s3outposts#ListEndpoints" + }, + { + "target": "com.amazonaws.s3outposts#ListSharedEndpoints" + } + ] }, "com.amazonaws.s3outposts#SecurityGroupId": { "type": "string", diff --git a/codegen/sdk-codegen/aws-models/secrets-manager.json b/codegen/sdk-codegen/aws-models/secrets-manager.json index 3b55b1b76938f..f8a15d1a4a916 100644 --- a/codegen/sdk-codegen/aws-models/secrets-manager.json +++ b/codegen/sdk-codegen/aws-models/secrets-manager.json @@ -1144,7 +1144,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account.

\n

To list the versions of a secret, use ListSecretVersionIds.

\n

To get the secret value from SecretString or SecretBinary, \n call GetSecretValue.

\n

For information about finding secrets in the console, see Enhanced search capabilities \n for secrets in Secrets Manager.

\n

\n Required permissions: \n secretsmanager:ListSecrets. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

", + "smithy.api#documentation": "

Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account, not including secrets \n that are marked for deletion. To see secrets marked for deletion, use the Secrets Manager console.

\n

To list the versions of a secret, use ListSecretVersionIds.

\n

To get the secret value from SecretString or SecretBinary, \n call GetSecretValue.

\n

For information about finding secrets in the console, see Enhanced search capabilities \n for secrets in Secrets Manager.

\n

\n Required permissions: \n secretsmanager:ListSecrets. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", diff --git a/codegen/sdk-codegen/aws-models/ssm-incidents.json b/codegen/sdk-codegen/aws-models/ssm-incidents.json index 200f5e6725d7d..a10737fdb3cf7 100644 --- a/codegen/sdk-codegen/aws-models/ssm-incidents.json +++ b/codegen/sdk-codegen/aws-models/ssm-incidents.json @@ -109,7 +109,7 @@ } }, "com.amazonaws.ssmincidents#AutomationExecutionSet": { - "type": "set", + "type": "list", "member": { "target": "com.amazonaws.ssmincidents#AutomationExecution" }, @@ -255,9 +255,9 @@ "traits": { "smithy.api#documentation": "

A replication set replicates and encrypts your data to the provided Regions with the\n provided KMS key.

", "smithy.api#http": { + "code": 201, "method": "POST", - "uri": "/createReplicationSet", - "code": 201 + "uri": "/createReplicationSet" } } }, @@ -324,9 +324,9 @@ "traits": { "smithy.api#documentation": "

Creates a response plan that automates the initial response to incidents. A response\n plan engages contacts, starts chat channel collaboration, and initiates runbooks at the\n beginning of an incident.

", "smithy.api#http": { + "code": 201, "method": "POST", - "uri": "/createResponsePlan", - "code": 201 + "uri": "/createResponsePlan" }, "smithy.api#idempotent": {} } @@ -432,9 +432,9 @@ "traits": { "smithy.api#documentation": "

Creates a custom timeline event on the incident details page of an incident record.\n Timeline events are automatically created by Incident Manager, marking key moment during an\n incident. You can create custom timeline events to mark important events that are\n automatically detected by Incident Manager.

", "smithy.api#http": { + "code": 201, "method": "POST", - "uri": "/createTimelineEvent", - "code": 201 + "uri": "/createTimelineEvent" }, "smithy.api#idempotent": {} } @@ -535,9 +535,9 @@ "traits": { "smithy.api#documentation": "

Delete an incident record from Incident Manager.

", "smithy.api#http": { + "code": 204, "method": "POST", - "uri": "/deleteIncidentRecord", - "code": 204 + "uri": "/deleteIncidentRecord" }, "smithy.api#idempotent": {} } @@ -603,9 +603,9 @@ "traits": { "smithy.api#documentation": "

Deletes all Regions in your replication set. Deleting the replication set deletes all\n Incident Manager data.

", "smithy.api#http": { + "code": 204, "method": "POST", - "uri": "/deleteReplicationSet", - "code": 204 + "uri": "/deleteReplicationSet" } } }, @@ -655,9 +655,9 @@ "traits": { "smithy.api#documentation": "

Deletes the resource policy that Resource Access Manager uses to share your Incident Manager\n resource.

", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/deleteResourcePolicy", - "code": 200 + "uri": "/deleteResourcePolicy" } } }, @@ -711,9 +711,9 @@ "traits": { "smithy.api#documentation": "

Deletes the specified response plan. Deleting a response plan stops all linked CloudWatch alarms and EventBridge events from creating an incident with this\n response plan.

", "smithy.api#http": { + "code": 204, "method": "POST", - "uri": "/deleteResponsePlan", - "code": 204 + "uri": "/deleteResponsePlan" }, "smithy.api#idempotent": {} } @@ -760,9 +760,9 @@ "traits": { "smithy.api#documentation": "

Deletes a timeline event from an incident.

", "smithy.api#http": { + "code": 204, "method": "POST", - "uri": "/deleteTimelineEvent", - "code": 204 + "uri": "/deleteTimelineEvent" }, "smithy.api#idempotent": {} } @@ -943,9 +943,9 @@ "traits": { "smithy.api#documentation": "

Returns the details for the specified incident record.

", "smithy.api#http": { + "code": 200, "method": "GET", - "uri": "/getIncidentRecord", - "code": 200 + "uri": "/getIncidentRecord" }, "smithy.api#readonly": {} } @@ -1004,14 +1004,16 @@ "traits": { "smithy.api#documentation": "

Retrieve your Incident Manager replication set.

", "smithy.api#http": { + "code": 200, "method": "GET", - "uri": "/getReplicationSet", - "code": 200 + "uri": "/getReplicationSet" }, "smithy.api#readonly": {}, "smithy.waiters#waitable": { "WaitForReplicationSetActive": { "documentation": "Wait for a replication set to become ACTIVE", + "minDelay": 30, + "maxDelay": 30, "acceptors": [ { "state": "success", @@ -1053,12 +1055,12 @@ } } } - ], - "minDelay": 30, - "maxDelay": 30 + ] }, "WaitForReplicationSetDeleted": { "documentation": "Wait for a replication set to be deleted", + "minDelay": 30, + "maxDelay": 30, "acceptors": [ { "state": "success", @@ -1086,9 +1088,7 @@ } } } - ], - "minDelay": 30, - "maxDelay": 30 + ] } } } @@ -1147,15 +1147,15 @@ "traits": { "smithy.api#documentation": "

Retrieves the resource policies attached to the specified response plan.

", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/getResourcePolicies", - "code": 200 + "uri": "/getResourcePolicies" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "resourcePolicies", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "resourcePolicies" }, "smithy.api#readonly": {} } @@ -1234,9 +1234,9 @@ "traits": { "smithy.api#documentation": "

Retrieves the details of the specified response plan.

", "smithy.api#http": { + "code": 200, "method": "GET", - "uri": "/getResponsePlan", - "code": 200 + "uri": "/getResponsePlan" }, "smithy.api#readonly": {} } @@ -1333,9 +1333,9 @@ "traits": { "smithy.api#documentation": "

Retrieves a timeline event based on its ID and incident record.

", "smithy.api#http": { + "code": 200, "method": "GET", - "uri": "/getTimelineEvent", - "code": 200 + "uri": "/getTimelineEvent" }, "smithy.api#readonly": {} } @@ -1498,7 +1498,7 @@ } }, "invokedBy": { - "target": "com.amazonaws.ssmincidents#Arn", + "target": "com.amazonaws.ssmincidents#ServicePrincipal", "traits": { "smithy.api#documentation": "

The principal the assumed the role specified of the createdBy.

", "smithy.api#tags": ["logs_investigations"] @@ -1811,15 +1811,15 @@ "traits": { "smithy.api#documentation": "

Lists all incident records in your account. Use this command to retrieve the Amazon\n Resource Name (ARN) of the incident record you want to update.

", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/listIncidentRecords", - "code": 200 + "uri": "/listIncidentRecords" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "incidentRecordSummaries", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "incidentRecordSummaries" }, "smithy.api#readonly": {} } @@ -1892,15 +1892,15 @@ "traits": { "smithy.api#documentation": "

List all related items for an incident record.

", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/listRelatedItems", - "code": 200 + "uri": "/listRelatedItems" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "relatedItems", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "relatedItems" }, "smithy.api#readonly": {} } @@ -1975,15 +1975,15 @@ "traits": { "smithy.api#documentation": "

Lists details about the replication set configured in your account.

", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/listReplicationSets", - "code": 200 + "uri": "/listReplicationSets" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "replicationSetArns", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "replicationSetArns" }, "smithy.api#readonly": {} } @@ -2050,15 +2050,15 @@ "traits": { "smithy.api#documentation": "

Lists all response plans in your account.

", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/listResponsePlans", - "code": 200 + "uri": "/listResponsePlans" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "responsePlanSummaries", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "responsePlanSummaries" }, "smithy.api#readonly": {} } @@ -2128,9 +2128,9 @@ "traits": { "smithy.api#documentation": "

Lists the tags that are attached to the specified response plan.

", "smithy.api#http": { + "code": 200, "method": "GET", - "uri": "/tags/{resourceArn}", - "code": 200 + "uri": "/tags/{resourceArn}" }, "smithy.api#readonly": {} } @@ -2186,15 +2186,15 @@ "traits": { "smithy.api#documentation": "

Lists timeline events for the specified incident record.

", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/listTimelineEvents", - "code": 200 + "uri": "/listTimelineEvents" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "eventSummaries", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "eventSummaries" }, "smithy.api#readonly": {} } @@ -2306,7 +2306,7 @@ } }, "com.amazonaws.ssmincidents#NotificationTargetSet": { - "type": "set", + "type": "list", "member": { "target": "com.amazonaws.ssmincidents#NotificationTargetItem" }, @@ -2361,9 +2361,9 @@ "traits": { "smithy.api#documentation": "

Adds a resource policy to the specified response plan.

", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/putResourcePolicy", - "code": 200 + "uri": "/putResourcePolicy" } } }, @@ -2844,16 +2844,15 @@ "aws.api#service": { "sdkId": "SSM Incidents", "arnNamespace": "ssm-incidents", - "cloudFormationName": "SSMIncidents", - "cloudTrailEventSource": "ssm-incidents.amazonaws.com", - "endpointPrefix": "ssm-incidents" + "awsProductName": "AWSSystemsManager", + "cloudFormationName": "SSMIncidents" }, "aws.auth#sigv4": { "name": "ssm-incidents" }, "aws.protocols#restJson1": {}, "smithy.api#cors": { - "additionalAllowedHeaders": ["x-amz-content-sha256", "x-amz-user-agent", "content-type", "x-amzn-platform-id"] + "additionalAllowedHeaders": ["content-type", "x-amz-content-sha256", "x-amz-user-agent", "x-amzn-platform-id"] }, "smithy.api#documentation": "

Systems Manager Incident Manager is an incident management console designed to help users\n mitigate and recover from incidents affecting their Amazon Web Services-hosted applications. An\n incident is any unplanned interruption or reduction in quality of services.

\n

Incident Manager increases incident resolution by notifying responders of impact,\n highlighting relevant troubleshooting data, and providing collaboration tools to get services\n back up and running. To achieve the primary goal of reducing the time-to-resolution of\n critical incidents, Incident Manager automates response plans and enables responder\n team escalation.

", "smithy.api#title": "AWS Systems Manager Incident Manager" @@ -2960,6 +2959,14 @@ ] } }, + "com.amazonaws.ssmincidents#ServicePrincipal": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1000 + } + } + }, "com.amazonaws.ssmincidents#ServiceQuotaExceededException": { "type": "structure", "members": { @@ -3178,9 +3185,9 @@ "traits": { "smithy.api#documentation": "

Used to start an incident from CloudWatch alarms, EventBridge events, or\n manually.

", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/startIncident", - "code": 200 + "uri": "/startIncident" }, "smithy.api#idempotent": {} } @@ -3336,9 +3343,9 @@ "traits": { "smithy.api#documentation": "

Adds a tag to a response plan.

", "smithy.api#http": { + "code": 204, "method": "POST", - "uri": "/tags/{resourceArn}", - "code": 204 + "uri": "/tags/{resourceArn}" } } }, @@ -3551,9 +3558,9 @@ "traits": { "smithy.api#documentation": "

Removes a tag from a resource.

", "smithy.api#http": { + "code": 204, "method": "DELETE", - "uri": "/tags/{resourceArn}", - "code": 204 + "uri": "/tags/{resourceArn}" }, "smithy.api#idempotent": {} } @@ -3618,9 +3625,9 @@ "traits": { "smithy.api#documentation": "

Update deletion protection to either allow or deny deletion of the final Region in a\n replication set.

", "smithy.api#http": { + "code": 204, "method": "POST", - "uri": "/updateDeletionProtection", - "code": 204 + "uri": "/updateDeletionProtection" } } }, @@ -3688,9 +3695,9 @@ "traits": { "smithy.api#documentation": "

Update the details of an incident record. You can use this operation to update an\n incident record from the defined chat channel. For more information about using actions\n in chat channels, see Interacting through chat.

", "smithy.api#http": { + "code": 204, "method": "POST", - "uri": "/updateIncidentRecord", - "code": 204 + "uri": "/updateIncidentRecord" }, "smithy.api#idempotent": {} } @@ -3788,9 +3795,9 @@ "traits": { "smithy.api#documentation": "

Add or remove related items from the related items tab of an incident record.

", "smithy.api#http": { + "code": 204, "method": "POST", - "uri": "/updateRelatedItems", - "code": 204 + "uri": "/updateRelatedItems" }, "smithy.api#idempotent": {} } @@ -3855,9 +3862,9 @@ "traits": { "smithy.api#documentation": "

Add or delete Regions from your replication set.

", "smithy.api#http": { + "code": 204, "method": "POST", - "uri": "/updateReplicationSet", - "code": 204 + "uri": "/updateReplicationSet" } } }, @@ -3948,9 +3955,9 @@ "traits": { "smithy.api#documentation": "

Updates the specified response plan.

", "smithy.api#http": { + "code": 204, "method": "POST", - "uri": "/updateResponsePlan", - "code": 204 + "uri": "/updateResponsePlan" }, "smithy.api#idempotent": {} } @@ -4066,9 +4073,9 @@ "traits": { "smithy.api#documentation": "

Updates a timeline event. You can update events of type Custom\n Event.

", "smithy.api#http": { + "code": 204, "method": "POST", - "uri": "/updateTimelineEvent", - "code": 204 + "uri": "/updateTimelineEvent" }, "smithy.api#idempotent": {} } diff --git a/codegen/sdk-codegen/aws-models/timestream-query.json b/codegen/sdk-codegen/aws-models/timestream-query.json index 101e8f9ee8f74..2d9de6180f6b6 100644 --- a/codegen/sdk-codegen/aws-models/timestream-query.json +++ b/codegen/sdk-codegen/aws-models/timestream-query.json @@ -1484,6 +1484,10 @@ { "value": "VARCHAR", "name": "VARCHAR" + }, + { + "value": "TIMESTAMP", + "name": "TIMESTAMP" } ] } diff --git a/codegen/sdk-codegen/aws-models/transcribe-streaming.json b/codegen/sdk-codegen/aws-models/transcribe-streaming.json index 11a1dc5e2281d..75c97eb88cb66 100644 --- a/codegen/sdk-codegen/aws-models/transcribe-streaming.json +++ b/codegen/sdk-codegen/aws-models/transcribe-streaming.json @@ -893,7 +893,7 @@ "MediaSampleRateHertz": { "target": "com.amazonaws.transcribestreaming#MediaSampleRateHertz", "traits": { - "smithy.api#documentation": "

The sample rate of the input audio in Hertz.

", + "smithy.api#documentation": "

The sample rate of the input audio (in Hertz). Amazon Transcribe medical supports a range from \n 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must match that of your\n audio.

", "smithy.api#httpHeader": "x-amzn-transcribe-sample-rate", "smithy.api#required": {} } @@ -993,7 +993,7 @@ "MediaSampleRateHertz": { "target": "com.amazonaws.transcribestreaming#MediaSampleRateHertz", "traits": { - "smithy.api#documentation": "

The sample rate of the input audio in Hertz.

", + "smithy.api#documentation": "

The sample rate of the input audio, in Hertz (Hz).

", "smithy.api#httpHeader": "x-amzn-transcribe-sample-rate" } }, @@ -1116,7 +1116,7 @@ "MediaSampleRateHertz": { "target": "com.amazonaws.transcribestreaming#MediaSampleRateHertz", "traits": { - "smithy.api#documentation": "

The sample rate, in Hertz (Hz), of the input audio. We suggest that you use 8,000 Hz \n for low quality audio and 16,000 Hz or higher for high quality audio.

", + "smithy.api#documentation": "

The sample rate of the input audio (in Hertz). Low-quality audio, such as telephone \n audio, is typically around 8,000 Hz. High-quality audio typically ranges from 16,000 Hz to \n 48,000 Hz. Note that the sample rate you specify must match that of your audio.

", "smithy.api#httpHeader": "x-amzn-transcribe-sample-rate", "smithy.api#required": {} } @@ -1132,7 +1132,7 @@ "VocabularyName": { "target": "com.amazonaws.transcribestreaming#VocabularyName", "traits": { - "smithy.api#documentation": "

The name of the vocabulary to use when processing the transcription job.

", + "smithy.api#documentation": "

The name of the custom vocabulary you want to use with your transcription.

\n

This operation is not intended for use in conjunction with the \n IdentifyLanguage operation. If you're using IdentifyLanguage\n in your request and want to use one or more custom vocabularies with your transcription, use the \n VocabularyNames operation instead.

", "smithy.api#httpHeader": "x-amzn-transcribe-vocabulary-name" } }, @@ -1154,7 +1154,7 @@ "VocabularyFilterName": { "target": "com.amazonaws.transcribestreaming#VocabularyFilterName", "traits": { - "smithy.api#documentation": "

The name of the vocabulary filter you've created that is unique to your account.\n Provide the name in this field to successfully use it in a stream.

", + "smithy.api#documentation": "

The name of the vocabulary filter you want to use with your transcription.

\n

This operation is not intended for use in conjunction with the \n IdentifyLanguage operation. If you're using IdentifyLanguage\n in your request and want to use one or more vocabulary filters with your transcription, use the \n VocabularyFilterNames operation instead.

", "smithy.api#httpHeader": "x-amzn-transcribe-vocabulary-filter-name" } }, @@ -1175,7 +1175,7 @@ "EnableChannelIdentification": { "target": "com.amazonaws.transcribestreaming#Boolean", "traits": { - "smithy.api#documentation": "

When true, instructs Amazon Transcribe to process each audio channel separately,\n then merges the transcription output of each channel into a single transcription.

\n

Amazon Transcribe also produces a transcription of each item. An item includes the start time, end\n time, and any alternative transcriptions.

\n

You can't set both ShowSpeakerLabel and\n EnableChannelIdentification in the same request. If you set both, your request\n returns a BadRequestException.

", + "smithy.api#documentation": "

When true, instructs Amazon Transcribe to process each audio channel separately,\n then merges the transcription output of each channel into a single transcription.

\n

Amazon Transcribe also produces a transcription of each item. An item includes the start time, end\n time, and any alternative transcriptions.

", "smithy.api#httpHeader": "x-amzn-transcribe-enable-channel-identification" } }, @@ -1248,6 +1248,20 @@ "smithy.api#documentation": "

Optional. From the subset of languages codes you provided for \n LanguageOptions, you can select one preferred language for your \n transcription.

\n

You can only use this parameter if you've set IdentifyLanguage to\n truein your request.

", "smithy.api#httpHeader": "x-amzn-transcribe-preferred-language" } + }, + "VocabularyNames": { + "target": "com.amazonaws.transcribestreaming#VocabularyNames", + "traits": { + "smithy.api#documentation": "

The names of the custom vocabularies you want to use with your transcription.

\n

Note that if the custom vocabularies you specify are in languages that don't match the \n language identified in your media, your job fails.

\n

This operation is only intended for use in conjunction with the \n IdentifyLanguage operation. If you're not using IdentifyLanguage\n in your request and want to use a custom vocabulary with your transcription, use the \n VocabularyName operation instead.

", + "smithy.api#httpHeader": "x-amzn-transcribe-vocabulary-names" + } + }, + "VocabularyFilterNames": { + "target": "com.amazonaws.transcribestreaming#VocabularyFilterNames", + "traits": { + "smithy.api#documentation": "

The names of the vocabulary filters you want to use with your transcription.

\n

Note that if the vocabulary filters you specify are in languages that don't match the \n language identified in your media, your job fails.

\n

This operation is only intended for use in conjunction with the \n IdentifyLanguage operation. If you're not using IdentifyLanguage\n in your request and want to use a vocabulary filter with your transcription, use the \n VocabularyFilterName operation instead.

", + "smithy.api#httpHeader": "x-amzn-transcribe-vocabulary-filter-names" + } } } }, @@ -1257,7 +1271,7 @@ "RequestId": { "target": "com.amazonaws.transcribestreaming#RequestId", "traits": { - "smithy.api#documentation": "

An identifier for the streaming transcription.

", + "smithy.api#documentation": "

An identifier for the transcription.

", "smithy.api#httpHeader": "x-amzn-request-id" } }, @@ -1271,7 +1285,7 @@ "MediaSampleRateHertz": { "target": "com.amazonaws.transcribestreaming#MediaSampleRateHertz", "traits": { - "smithy.api#documentation": "

The sample rate, in Hertz (Hz), for the input audio stream. Use 8,000 Hz for low quality \n audio and 16,000 Hz or higher for high quality audio.

", + "smithy.api#documentation": "

The sample rate, in Hertz (Hz), for the input audio stream.

", "smithy.api#httpHeader": "x-amzn-transcribe-sample-rate" } }, @@ -1285,7 +1299,7 @@ "VocabularyName": { "target": "com.amazonaws.transcribestreaming#VocabularyName", "traits": { - "smithy.api#documentation": "

The name of the vocabulary used when processing the stream.

", + "smithy.api#documentation": "

The name of the custom vocabulary used when processing the stream.

", "smithy.api#httpHeader": "x-amzn-transcribe-vocabulary-name" } }, @@ -1306,28 +1320,28 @@ "VocabularyFilterName": { "target": "com.amazonaws.transcribestreaming#VocabularyFilterName", "traits": { - "smithy.api#documentation": "

The name of the vocabulary filter used in your media stream.

", + "smithy.api#documentation": "

The name of the vocabulary filter used when processing the stream.

", "smithy.api#httpHeader": "x-amzn-transcribe-vocabulary-filter-name" } }, "VocabularyFilterMethod": { "target": "com.amazonaws.transcribestreaming#VocabularyFilterMethod", "traits": { - "smithy.api#documentation": "

The vocabulary filtering method used in the media stream.

", + "smithy.api#documentation": "

The vocabulary filtering method used when processing the stream.

", "smithy.api#httpHeader": "x-amzn-transcribe-vocabulary-filter-method" } }, "ShowSpeakerLabel": { "target": "com.amazonaws.transcribestreaming#Boolean", "traits": { - "smithy.api#documentation": "

Shows whether speaker identification was enabled in the stream.

", + "smithy.api#documentation": "

Shows whether speaker identification was enabled in the transcription.

", "smithy.api#httpHeader": "x-amzn-transcribe-show-speaker-label" } }, "EnableChannelIdentification": { "target": "com.amazonaws.transcribestreaming#Boolean", "traits": { - "smithy.api#documentation": "

Shows whether channel identification has been enabled in the stream.

", + "smithy.api#documentation": "

Shows whether channel identification was enabled in the stream.

", "smithy.api#httpHeader": "x-amzn-transcribe-enable-channel-identification" } }, @@ -1341,7 +1355,7 @@ "EnablePartialResultsStabilization": { "target": "com.amazonaws.transcribestreaming#Boolean", "traits": { - "smithy.api#documentation": "

Shows whether partial results stabilization has been enabled in the stream.

", + "smithy.api#documentation": "

Shows whether partial results stabilization was enabled in the transcription.

", "smithy.api#httpHeader": "x-amzn-transcribe-enable-partial-results-stabilization" } }, @@ -1376,7 +1390,7 @@ "LanguageModelName": { "target": "com.amazonaws.transcribestreaming#ModelName", "traits": { - "smithy.api#documentation": "

The name of the language model used in your media stream.

", + "smithy.api#documentation": "

The name of the custom language model used in the transcription.

", "smithy.api#httpHeader": "x-amzn-transcribe-language-model-name" } }, @@ -1400,6 +1414,20 @@ "smithy.api#documentation": "

The preferred language you specified in your request.

", "smithy.api#httpHeader": "x-amzn-transcribe-preferred-language" } + }, + "VocabularyNames": { + "target": "com.amazonaws.transcribestreaming#VocabularyNames", + "traits": { + "smithy.api#documentation": "

The name of the custom vocabulary used when processing the stream.

", + "smithy.api#httpHeader": "x-amzn-transcribe-vocabulary-names" + } + }, + "VocabularyFilterNames": { + "target": "com.amazonaws.transcribestreaming#VocabularyFilterNames", + "traits": { + "smithy.api#documentation": "

The name of the vocabulary filter used when processing the stream.

", + "smithy.api#httpHeader": "x-amzn-transcribe-vocabulary-filter-names" + } } } }, @@ -1550,6 +1578,16 @@ "smithy.api#pattern": "^[0-9a-zA-Z._-]+$" } }, + "com.amazonaws.transcribestreaming#VocabularyFilterNames": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 3000 + }, + "smithy.api#pattern": "^[a-zA-Z0-9,-._]+$" + } + }, "com.amazonaws.transcribestreaming#VocabularyName": { "type": "string", "traits": { @@ -1559,6 +1597,16 @@ }, "smithy.api#pattern": "^[0-9a-zA-Z._-]+$" } + }, + "com.amazonaws.transcribestreaming#VocabularyNames": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 3000 + }, + "smithy.api#pattern": "^[a-zA-Z0-9,-._]+$" + } } } } From 0983b276f1595c0a4b117ba0fc8acf88fdc0d046 Mon Sep 17 00:00:00 2001 From: AllanZhengYP Date: Mon, 21 Mar 2022 19:19:58 +0000 Subject: [PATCH 2/2] feat(clients): update clients as of 03/21/2022 --- clients/client-acm-pca/README.md | 27 +- clients/client-acm-pca/src/ACMPCA.ts | 221 +- clients/client-acm-pca/src/ACMPCAClient.ts | 27 +- ...eCertificateAuthorityAuditReportCommand.ts | 20 +- .../CreateCertificateAuthorityCommand.ts | 30 +- .../src/commands/CreatePermissionCommand.ts | 6 +- .../DeleteCertificateAuthorityCommand.ts | 4 +- .../src/commands/DeletePermissionCommand.ts | 8 +- .../src/commands/DeletePolicyCommand.ts | 18 +- .../DescribeCertificateAuthorityCommand.ts | 8 +- .../GetCertificateAuthorityCsrCommand.ts | 6 +- .../src/commands/GetPolicyCommand.ts | 14 +- ...tCertificateAuthorityCertificateCommand.ts | 20 +- .../src/commands/IssueCertificateCommand.ts | 2 +- .../src/commands/ListPermissionsCommand.ts | 6 +- .../src/commands/PutPolicyCommand.ts | 16 +- .../src/commands/RevokeCertificateCommand.ts | 26 +- .../TagCertificateAuthorityCommand.ts | 2 +- .../UpdateCertificateAuthorityCommand.ts | 8 +- clients/client-acm-pca/src/models/models_0.ts | 292 +- .../src/protocols/Aws_json1_1.ts | 72 + .../src/models/models_0.ts | 96 +- .../src/protocols/Aws_restJson1.ts | 69 + clients/client-billingconductor/.gitignore | 9 + clients/client-billingconductor/LICENSE | 201 + clients/client-billingconductor/README.md | 215 + clients/client-billingconductor/package.json | 95 + .../src/Billingconductor.ts | 1184 +++++ .../src/BillingconductorClient.ts | 400 ++ .../src/commands/AssociateAccountsCommand.ts | 98 + .../commands/AssociatePricingRulesCommand.ts | 96 + ...sociateResourcesToCustomLineItemCommand.ts | 112 + ...ciateResourcesFromCustomLineItemCommand.ts | 112 + .../src/commands/CreateBillingGroupCommand.ts | 97 + .../commands/CreateCustomLineItemCommand.ts | 97 + .../src/commands/CreatePricingPlanCommand.ts | 96 + .../src/commands/CreatePricingRuleCommand.ts | 97 + .../src/commands/DeleteBillingGroupCommand.ts | 97 + .../commands/DeleteCustomLineItemCommand.ts | 97 + .../src/commands/DeletePricingPlanCommand.ts | 96 + .../src/commands/DeletePricingRuleCommand.ts | 95 + .../commands/DisassociateAccountsCommand.ts | 95 + .../DisassociatePricingRulesCommand.ts | 97 + .../ListAccountAssociationsCommand.ts | 103 + .../ListBillingGroupCostReportsCommand.ts | 99 + .../src/commands/ListBillingGroupsCommand.ts | 95 + .../commands/ListCustomLineItemsCommand.ts | 97 + ...ngPlansAssociatedWithPricingRuleCommand.ts | 112 + .../src/commands/ListPricingPlansCommand.ts | 96 + ...cingRulesAssociatedToPricingPlanCommand.ts | 112 + .../src/commands/ListPricingRulesCommand.ts | 97 + ...ourcesAssociatedToCustomLineItemCommand.ts | 112 + .../commands/ListTagsForResourceCommand.ts | 97 + .../src/commands/TagResourceCommand.ts | 97 + .../src/commands/UntagResourceCommand.ts | 97 + .../src/commands/UpdateBillingGroupCommand.ts | 96 + .../commands/UpdateCustomLineItemCommand.ts | 97 + .../src/commands/UpdatePricingPlanCommand.ts | 96 + .../src/commands/UpdatePricingRuleCommand.ts | 97 + .../src/commands/index.ts | 30 + .../client-billingconductor/src/endpoints.ts | 135 + clients/client-billingconductor/src/index.ts | 6 + .../BillingconductorServiceException.ts | 17 + .../src/models/index.ts | 1 + .../src/models/models_0.ts | 3239 ++++++++++++++ .../src/pagination/Interfaces.ts | 8 + .../ListAccountAssociationsPaginator.ts | 58 + .../ListBillingGroupCostReportsPaginator.ts | 59 + .../pagination/ListBillingGroupsPaginator.ts | 59 + .../ListCustomLineItemsPaginator.ts | 59 + ...PlansAssociatedWithPricingRulePaginator.ts | 59 + .../pagination/ListPricingPlansPaginator.ts | 59 + ...ngRulesAssociatedToPricingPlanPaginator.ts | 59 + .../pagination/ListPricingRulesPaginator.ts | 59 + ...rcesAssociatedToCustomLineItemPaginator.ts | 59 + .../src/pagination/index.ts | 10 + .../src/protocols/Aws_restJson1.ts | 3840 +++++++++++++++++ .../src/runtimeConfig.browser.ts | 49 + .../src/runtimeConfig.native.ts | 17 + .../src/runtimeConfig.shared.ts | 17 + .../src/runtimeConfig.ts | 65 + .../client-billingconductor/tsconfig.cjs.json | 8 + .../client-billingconductor/tsconfig.es.json | 10 + clients/client-billingconductor/tsconfig.json | 13 + .../tsconfig.types.json | 10 + clients/client-billingconductor/typedoc.json | 3 + .../src/models/models_0.ts | 15 + .../src/protocols/Aws_restJson1.ts | 5 + clients/client-chime/src/Chime.ts | 2 +- .../UpdateSipMediaApplicationCallCommand.ts | 2 +- clients/client-chime/src/models/models_0.ts | 6 +- clients/client-chime/src/models/models_1.ts | 7 +- .../src/protocols/Aws_restJson1.ts | 6 + .../src/CognitoIdentityProvider.ts | 511 +-- .../src/commands/AdminCreateUserCommand.ts | 34 +- .../AdminDisableProviderForUserCommand.ts | 11 +- .../src/commands/AdminInitiateAuthCommand.ts | 33 +- .../commands/AdminResetUserPasswordCommand.ts | 34 +- .../AdminRespondToAuthChallengeCommand.ts | 33 +- .../AdminUpdateUserAttributesCommand.ts | 33 +- .../src/commands/CreateUserPoolCommand.ts | 34 +- .../src/commands/ForgotPasswordCommand.ts | 34 +- ...GetUserAttributeVerificationCodeCommand.ts | 34 +- .../src/commands/InitiateAuthCommand.ts | 33 +- .../commands/ResendConfirmationCodeCommand.ts | 34 +- .../commands/RespondToAuthChallengeCommand.ts | 33 +- .../commands/SetUserPoolMfaConfigCommand.ts | 29 +- .../src/commands/SignUpCommand.ts | 34 +- .../commands/UpdateUserAttributesCommand.ts | 34 +- .../src/commands/UpdateUserPoolCommand.ts | 34 +- .../src/models/models_0.ts | 566 ++- .../src/models/models_1.ts | 33 +- .../src/protocols/Aws_json1_1.ts | 5 +- .../src/ConfigService.ts | 2 +- .../PutConfigurationAggregatorCommand.ts | 2 +- .../src/models/models_0.ts | 4 +- clients/client-connect/src/Connect.ts | 28 +- .../commands/StartContactRecordingCommand.ts | 12 +- .../src/commands/StopContactCommand.ts | 16 +- clients/client-connect/src/models/models_0.ts | 7 +- .../src/protocols/Aws_restJson1.ts | 18 + .../client-dataexchange/src/DataExchange.ts | 37 + .../src/DataExchangeClient.ts | 3 + .../src/commands/RevokeRevisionCommand.ts | 95 + .../client-dataexchange/src/commands/index.ts | 1 + .../src/models/models_0.ts | 157 +- .../src/protocols/Aws_restJson1.ts | 190 + clients/client-ec2/src/EC2.ts | 6 +- .../commands/MoveByoipCidrToIpamCommand.ts | 1 + .../commands/ProvisionIpamPoolCidrCommand.ts | 2 +- .../ProvisionPublicIpv4PoolCidrCommand.ts | 3 +- clients/client-ec2/src/models/models_1.ts | 3 +- clients/client-ec2/src/models/models_2.ts | 26 + clients/client-ec2/src/models/models_5.ts | 2 +- clients/client-ec2/src/protocols/Aws_ec2.ts | 3 + clients/client-ecr/src/models/models_0.ts | 4 +- clients/client-ecs/src/ECS.ts | 20 +- .../UpdateContainerInstancesStateCommand.ts | 3 +- .../src/commands/UpdateServiceCommand.ts | 17 +- clients/client-ecs/src/models/models_0.ts | 59 +- .../client-elasticache/src/models/models_0.ts | 5 +- clients/client-glue/src/Glue.ts | 304 ++ clients/client-glue/src/GlueClient.ts | 27 + .../src/commands/CancelStatementCommand.ts | 95 + .../src/commands/CreateSessionCommand.ts | 95 + .../src/commands/DeleteSessionCommand.ts | 95 + .../src/commands/GetConnectionCommand.ts | 2 +- .../src/commands/GetConnectionsCommand.ts | 2 +- .../src/commands/GetCrawlerCommand.ts | 2 +- .../src/commands/GetCrawlerMetricsCommand.ts | 3 +- .../src/commands/GetSessionCommand.ts | 95 + .../src/commands/GetStatementCommand.ts | 95 + .../src/commands/ListSessionsCommand.ts | 95 + .../src/commands/ListStatementsCommand.ts | 95 + .../src/commands/RunStatementCommand.ts | 95 + .../src/commands/StopSessionCommand.ts | 95 + .../src/commands/UpdateTriggerCommand.ts | 2 +- .../UpdateUserDefinedFunctionCommand.ts | 2 +- .../src/commands/UpdateWorkflowCommand.ts | 2 +- clients/client-glue/src/commands/index.ts | 9 + clients/client-glue/src/models/index.ts | 1 + clients/client-glue/src/models/models_0.ts | 776 ++-- clients/client-glue/src/models/models_1.ts | 1014 ++++- clients/client-glue/src/models/models_2.ts | 179 + .../src/pagination/ListSessionsPaginator.ts | 59 + clients/client-glue/src/pagination/index.ts | 1 + .../client-glue/src/protocols/Aws_json1_1.ts | 1104 ++++- clients/client-kendra/src/models/models_0.ts | 591 ++- .../src/protocols/Aws_json1_1.ts | 163 + clients/client-keyspaces/README.md | 10 +- clients/client-keyspaces/src/Keyspaces.ts | 74 +- .../client-keyspaces/src/KeyspacesClient.ts | 12 +- .../src/commands/CreateKeyspaceCommand.ts | 4 +- .../src/commands/CreateTableCommand.ts | 4 +- .../src/commands/DeleteTableCommand.ts | 3 +- .../src/commands/RestoreTableCommand.ts | 51 +- .../client-keyspaces/src/models/models_0.ts | 409 +- clients/client-lambda/src/Lambda.ts | 16 +- .../src/commands/AddPermissionCommand.ts | 16 +- clients/client-lambda/src/models/models_0.ts | 6 + .../src/protocols/Aws_restJson1.ts | 2 + .../client-location/src/models/models_0.ts | 40 +- .../src/models/models_0.ts | 117 + .../src/protocols/Aws_restJson1.ts | 46 + clients/client-outposts/src/Outposts.ts | 7 +- .../src/commands/ListSitesCommand.ts | 7 +- .../client-outposts/src/models/models_0.ts | 26 + .../src/protocols/Aws_restJson1.ts | 11 + clients/client-quicksight/src/QuickSight.ts | 75 +- .../client-quicksight/src/QuickSightClient.ts | 9 + .../src/commands/CreateGroupCommand.ts | 2 +- .../DescribeGroupMembershipCommand.ts | 97 + .../src/commands/DescribeUserCommand.ts | 3 +- .../src/commands/SearchGroupsCommand.ts | 95 + .../client-quicksight/src/commands/index.ts | 2 + .../client-quicksight/src/models/models_0.ts | 101 +- .../client-quicksight/src/models/models_1.ts | 152 +- .../src/protocols/Aws_restJson1.ts | 279 ++ clients/client-ram/src/RAM.ts | 6 +- .../src/commands/ListResourcesCommand.ts | 2 +- ...teResourceShareCreatedFromPolicyCommand.ts | 4 +- clients/client-ram/src/models/models_0.ts | 23 +- clients/client-rds/README.md | 7 +- clients/client-rds/src/RDS.ts | 775 ++-- clients/client-rds/src/RDSClient.ts | 33 +- .../src/commands/AddTagsToResourceCommand.ts | 2 +- .../AuthorizeDBSecurityGroupIngressCommand.ts | 9 +- .../src/commands/BacktrackDBClusterCommand.ts | 3 +- .../src/commands/CancelExportTaskCommand.ts | 3 +- .../commands/CopyDBClusterSnapshotCommand.ts | 55 +- .../src/commands/CopyDBSnapshotCommand.ts | 8 +- .../CreateCustomDBEngineVersionCommand.ts | 6 +- .../src/commands/CreateDBClusterCommand.ts | 12 +- .../CreateDBClusterParameterGroupCommand.ts | 23 +- .../CreateDBClusterSnapshotCommand.ts | 10 +- .../CreateDBInstanceReadReplicaCommand.ts | 16 +- .../commands/CreateDBParameterGroupCommand.ts | 12 +- .../commands/CreateDBProxyEndpointCommand.ts | 6 +- .../commands/CreateDBSecurityGroupCommand.ts | 4 +- .../CreateEventSubscriptionCommand.ts | 9 +- .../commands/CreateGlobalClusterCommand.ts | 18 +- .../src/commands/CreateOptionGroupCommand.ts | 2 +- .../DeleteCustomDBEngineVersionCommand.ts | 6 +- .../src/commands/DeleteDBClusterCommand.ts | 10 +- .../DeleteDBClusterEndpointCommand.ts | 6 +- .../DeleteDBClusterParameterGroupCommand.ts | 10 +- .../DeleteDBClusterSnapshotCommand.ts | 14 +- .../src/commands/DeleteDBInstanceCommand.ts | 19 +- .../commands/DeleteDBSecurityGroupCommand.ts | 4 +- .../src/commands/DeleteDBSnapshotCommand.ts | 4 +- .../commands/DeleteDBSubnetGroupCommand.ts | 4 +- .../commands/DeleteGlobalClusterCommand.ts | 12 +- .../DescribeAccountAttributesCommand.ts | 2 +- .../DescribeDBClusterBacktracksCommand.ts | 3 +- .../DescribeDBClusterEndpointsCommand.ts | 6 +- ...DescribeDBClusterParameterGroupsCommand.ts | 16 +- .../DescribeDBClusterParametersCommand.ts | 10 +- .../DescribeDBClusterSnapshotsCommand.ts | 10 +- .../src/commands/DescribeDBClustersCommand.ts | 12 +- ...scribeDBInstanceAutomatedBackupsCommand.ts | 2 +- .../commands/DescribeDBInstancesCommand.ts | 4 +- .../src/commands/DescribeDBLogFilesCommand.ts | 2 +- .../DescribeDBParameterGroupsCommand.ts | 6 +- .../DescribeDBSecurityGroupsCommand.ts | 6 +- .../DescribeDBSnapshotAttributesCommand.ts | 4 +- .../commands/DescribeDBSubnetGroupsCommand.ts | 5 +- ...beEngineDefaultClusterParametersCommand.ts | 5 +- .../DescribeEventCategoriesCommand.ts | 7 +- .../DescribeEventSubscriptionsCommand.ts | 2 +- .../src/commands/DescribeEventsCommand.ts | 4 +- .../commands/DescribeExportTasksCommand.ts | 2 +- .../commands/DescribeGlobalClustersCommand.ts | 16 +- ...ribeValidDBInstanceModificationsCommand.ts | 3 +- .../DownloadDBLogFilePortionCommand.ts | 2 +- .../src/commands/FailoverDBClusterCommand.ts | 18 +- .../commands/FailoverGlobalClusterCommand.ts | 14 +- .../commands/ListTagsForResourceCommand.ts | 2 +- .../src/commands/ModifyCertificatesCommand.ts | 14 +- .../ModifyCurrentDBClusterCapacityCommand.ts | 22 +- .../ModifyCustomDBEngineVersionCommand.ts | 4 +- .../src/commands/ModifyDBClusterCommand.ts | 10 +- .../ModifyDBClusterEndpointCommand.ts | 6 +- .../ModifyDBClusterParameterGroupCommand.ts | 15 +- .../src/commands/ModifyDBInstanceCommand.ts | 3 +- .../commands/ModifyDBParameterGroupCommand.ts | 10 +- .../ModifyDBSnapshotAttributeCommand.ts | 4 +- .../src/commands/ModifyDBSnapshotCommand.ts | 8 +- .../ModifyEventSubscriptionCommand.ts | 2 +- .../commands/ModifyGlobalClusterCommand.ts | 12 +- .../src/commands/PromoteReadReplicaCommand.ts | 13 +- .../src/commands/RebootDBClusterCommand.ts | 15 +- .../src/commands/RebootDBInstanceCommand.ts | 15 +- .../RemoveFromGlobalClusterCommand.ts | 12 +- .../RemoveRoleFromDBClusterCommand.ts | 3 +- .../commands/RemoveTagsFromResourceCommand.ts | 2 +- .../ResetDBClusterParameterGroupCommand.ts | 16 +- .../commands/ResetDBParameterGroupCommand.ts | 2 +- .../commands/RestoreDBClusterFromS3Command.ts | 5 +- .../RestoreDBClusterFromSnapshotCommand.ts | 11 +- .../RestoreDBClusterToPointInTimeCommand.ts | 13 +- .../RestoreDBInstanceFromDBSnapshotCommand.ts | 8 +- .../RestoreDBInstanceFromS3Command.ts | 2 +- .../RestoreDBInstanceToPointInTimeCommand.ts | 6 +- .../src/commands/StartDBClusterCommand.ts | 12 +- .../src/commands/StartDBInstanceCommand.ts | 12 +- .../src/commands/StartExportTaskCommand.ts | 3 +- .../src/commands/StopDBClusterCommand.ts | 18 +- .../src/commands/StopDBInstanceCommand.ts | 14 +- clients/client-rds/src/models/models_0.ts | 3409 +++++++-------- clients/client-rds/src/models/models_1.ts | 2870 ++++++------ .../client-robomaker/src/models/models_0.ts | 40 +- .../src/protocols/Aws_restJson1.ts | 4 + clients/client-s3outposts/src/S3Outposts.ts | 78 +- .../client-s3outposts/src/S3OutpostsClient.ts | 16 +- .../src/commands/CreateEndpointCommand.ts | 8 +- .../src/commands/DeleteEndpointCommand.ts | 8 +- .../src/commands/ListEndpointsCommand.ts | 12 +- .../commands/ListSharedEndpointsCommand.ts | 108 + .../client-s3outposts/src/commands/index.ts | 1 + .../client-s3outposts/src/models/models_0.ts | 93 +- .../ListSharedEndpointsPaginator.ts | 59 + .../client-s3outposts/src/pagination/index.ts | 1 + .../src/protocols/Aws_restJson1.ts | 87 + .../src/SecretsManager.ts | 3 +- .../src/commands/ListSecretsCommand.ts | 3 +- .../src/models/models_0.ts | 1 + .../src/models/models_0.ts | 78 +- .../src/protocols/Aws_restJson1.ts | 14 + 308 files changed, 24639 insertions(+), 7107 deletions(-) create mode 100644 clients/client-billingconductor/.gitignore create mode 100644 clients/client-billingconductor/LICENSE create mode 100644 clients/client-billingconductor/README.md create mode 100644 clients/client-billingconductor/package.json create mode 100644 clients/client-billingconductor/src/Billingconductor.ts create mode 100644 clients/client-billingconductor/src/BillingconductorClient.ts create mode 100644 clients/client-billingconductor/src/commands/AssociateAccountsCommand.ts create mode 100644 clients/client-billingconductor/src/commands/AssociatePricingRulesCommand.ts create mode 100644 clients/client-billingconductor/src/commands/BatchAssociateResourcesToCustomLineItemCommand.ts create mode 100644 clients/client-billingconductor/src/commands/BatchDisassociateResourcesFromCustomLineItemCommand.ts create mode 100644 clients/client-billingconductor/src/commands/CreateBillingGroupCommand.ts create mode 100644 clients/client-billingconductor/src/commands/CreateCustomLineItemCommand.ts create mode 100644 clients/client-billingconductor/src/commands/CreatePricingPlanCommand.ts create mode 100644 clients/client-billingconductor/src/commands/CreatePricingRuleCommand.ts create mode 100644 clients/client-billingconductor/src/commands/DeleteBillingGroupCommand.ts create mode 100644 clients/client-billingconductor/src/commands/DeleteCustomLineItemCommand.ts create mode 100644 clients/client-billingconductor/src/commands/DeletePricingPlanCommand.ts create mode 100644 clients/client-billingconductor/src/commands/DeletePricingRuleCommand.ts create mode 100644 clients/client-billingconductor/src/commands/DisassociateAccountsCommand.ts create mode 100644 clients/client-billingconductor/src/commands/DisassociatePricingRulesCommand.ts create mode 100644 clients/client-billingconductor/src/commands/ListAccountAssociationsCommand.ts create mode 100644 clients/client-billingconductor/src/commands/ListBillingGroupCostReportsCommand.ts create mode 100644 clients/client-billingconductor/src/commands/ListBillingGroupsCommand.ts create mode 100644 clients/client-billingconductor/src/commands/ListCustomLineItemsCommand.ts create mode 100644 clients/client-billingconductor/src/commands/ListPricingPlansAssociatedWithPricingRuleCommand.ts create mode 100644 clients/client-billingconductor/src/commands/ListPricingPlansCommand.ts create mode 100644 clients/client-billingconductor/src/commands/ListPricingRulesAssociatedToPricingPlanCommand.ts create mode 100644 clients/client-billingconductor/src/commands/ListPricingRulesCommand.ts create mode 100644 clients/client-billingconductor/src/commands/ListResourcesAssociatedToCustomLineItemCommand.ts create mode 100644 clients/client-billingconductor/src/commands/ListTagsForResourceCommand.ts create mode 100644 clients/client-billingconductor/src/commands/TagResourceCommand.ts create mode 100644 clients/client-billingconductor/src/commands/UntagResourceCommand.ts create mode 100644 clients/client-billingconductor/src/commands/UpdateBillingGroupCommand.ts create mode 100644 clients/client-billingconductor/src/commands/UpdateCustomLineItemCommand.ts create mode 100644 clients/client-billingconductor/src/commands/UpdatePricingPlanCommand.ts create mode 100644 clients/client-billingconductor/src/commands/UpdatePricingRuleCommand.ts create mode 100644 clients/client-billingconductor/src/commands/index.ts create mode 100644 clients/client-billingconductor/src/endpoints.ts create mode 100644 clients/client-billingconductor/src/index.ts create mode 100644 clients/client-billingconductor/src/models/BillingconductorServiceException.ts create mode 100644 clients/client-billingconductor/src/models/index.ts create mode 100644 clients/client-billingconductor/src/models/models_0.ts create mode 100644 clients/client-billingconductor/src/pagination/Interfaces.ts create mode 100644 clients/client-billingconductor/src/pagination/ListAccountAssociationsPaginator.ts create mode 100644 clients/client-billingconductor/src/pagination/ListBillingGroupCostReportsPaginator.ts create mode 100644 clients/client-billingconductor/src/pagination/ListBillingGroupsPaginator.ts create mode 100644 clients/client-billingconductor/src/pagination/ListCustomLineItemsPaginator.ts create mode 100644 clients/client-billingconductor/src/pagination/ListPricingPlansAssociatedWithPricingRulePaginator.ts create mode 100644 clients/client-billingconductor/src/pagination/ListPricingPlansPaginator.ts create mode 100644 clients/client-billingconductor/src/pagination/ListPricingRulesAssociatedToPricingPlanPaginator.ts create mode 100644 clients/client-billingconductor/src/pagination/ListPricingRulesPaginator.ts create mode 100644 clients/client-billingconductor/src/pagination/ListResourcesAssociatedToCustomLineItemPaginator.ts create mode 100644 clients/client-billingconductor/src/pagination/index.ts create mode 100644 clients/client-billingconductor/src/protocols/Aws_restJson1.ts create mode 100644 clients/client-billingconductor/src/runtimeConfig.browser.ts create mode 100644 clients/client-billingconductor/src/runtimeConfig.native.ts create mode 100644 clients/client-billingconductor/src/runtimeConfig.shared.ts create mode 100644 clients/client-billingconductor/src/runtimeConfig.ts create mode 100644 clients/client-billingconductor/tsconfig.cjs.json create mode 100644 clients/client-billingconductor/tsconfig.es.json create mode 100644 clients/client-billingconductor/tsconfig.json create mode 100644 clients/client-billingconductor/tsconfig.types.json create mode 100644 clients/client-billingconductor/typedoc.json create mode 100644 clients/client-dataexchange/src/commands/RevokeRevisionCommand.ts create mode 100644 clients/client-glue/src/commands/CancelStatementCommand.ts create mode 100644 clients/client-glue/src/commands/CreateSessionCommand.ts create mode 100644 clients/client-glue/src/commands/DeleteSessionCommand.ts create mode 100644 clients/client-glue/src/commands/GetSessionCommand.ts create mode 100644 clients/client-glue/src/commands/GetStatementCommand.ts create mode 100644 clients/client-glue/src/commands/ListSessionsCommand.ts create mode 100644 clients/client-glue/src/commands/ListStatementsCommand.ts create mode 100644 clients/client-glue/src/commands/RunStatementCommand.ts create mode 100644 clients/client-glue/src/commands/StopSessionCommand.ts create mode 100644 clients/client-glue/src/models/models_2.ts create mode 100644 clients/client-glue/src/pagination/ListSessionsPaginator.ts create mode 100644 clients/client-quicksight/src/commands/DescribeGroupMembershipCommand.ts create mode 100644 clients/client-quicksight/src/commands/SearchGroupsCommand.ts create mode 100644 clients/client-s3outposts/src/commands/ListSharedEndpointsCommand.ts create mode 100644 clients/client-s3outposts/src/pagination/ListSharedEndpointsPaginator.ts diff --git a/clients/client-acm-pca/README.md b/clients/client-acm-pca/README.md index 55e84ba435100..21efd6524d0b4 100644 --- a/clients/client-acm-pca/README.md +++ b/clients/client-acm-pca/README.md @@ -7,23 +7,22 @@ AWS SDK for JavaScript ACMPCA Client for Node.js, Browser and React Native. -

This is the ACM Private CA API Reference. It provides descriptions, +

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

-

The documentation for each action shows the Query API request parameters and the XML -response. Alternatively, you can use one of the AWS SDKs to access an API that's -tailored to the programming language or platform that you're using. For more -information, see AWS -SDKs.

-

Each ACM Private CA API operation has a quota that determines the number of times the operation -can be called per second. ACM Private CA throttles API requests at different rates depending -on the operation. Throttling means that ACM Private CA rejects an otherwise valid request -because the request exceeds the operation's quota for the number of requests per second. -When a request is throttled, ACM Private CA returns a ThrottlingException error. ACM Private CA does not guarantee a minimum request +and managing a private certificate authority (CA) for your organization.

+

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

+

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

-

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

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

## Installing diff --git a/clients/client-acm-pca/src/ACMPCA.ts b/clients/client-acm-pca/src/ACMPCA.ts index 9208c7ce63519..bc8cb2bb70d20 100644 --- a/clients/client-acm-pca/src/ACMPCA.ts +++ b/clients/client-acm-pca/src/ACMPCA.ts @@ -106,48 +106,47 @@ import { } from "./commands/UpdateCertificateAuthorityCommand"; /** - *

This is the ACM Private CA API Reference. It provides descriptions, + *

This is the Amazon Web Services Private Certificate Authority API Reference. It provides descriptions, * syntax, and usage examples for each of the actions and data types involved in creating - * and managing private certificate authorities (CA) for your organization.

- *

The documentation for each action shows the Query API request parameters and the XML - * response. Alternatively, you can use one of the AWS SDKs to access an API that's - * tailored to the programming language or platform that you're using. For more - * information, see AWS - * SDKs.

- *

Each ACM Private CA API operation has a quota that determines the number of times the operation - * can be called per second. ACM Private CA throttles API requests at different rates depending - * on the operation. Throttling means that ACM Private CA rejects an otherwise valid request - * because the request exceeds the operation's quota for the number of requests per second. - * When a request is throttled, ACM Private CA returns a ThrottlingException error. ACM Private CA does not guarantee a minimum request + * and managing a private certificate authority (CA) for your organization.

+ *

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

+ *

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

* - *

To see an up-to-date list of your ACM Private CA quotas, or to request a quota increase, - * log into your AWS account and visit the Service Quotas + *

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

*/ export class ACMPCA extends ACMPCAClient { /** *

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

- *

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

+ *

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

- * + * *

Both PCA and the IAM principal must have permission to write to * the S3 bucket that you specify. If the IAM principal making the call * does not have permission to write to the bucket, then an exception is - * thrown. For more information, see Configure - * Access to ACM Private CA.

- * + * thrown. For more information, see Access + * policies for CRLs in Amazon S3.

+ * */ public createCertificateAuthority( args: CreateCertificateAuthorityCommandInput, @@ -179,22 +178,22 @@ export class ACMPCA extends ACMPCAClient { } /** - *

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 + *

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

- * + * *

Both PCA and the IAM principal must have permission to write to * the S3 bucket that you specify. If the IAM principal making the call * does not have permission to write to the bucket, then an exception is - * thrown. For more information, see Configure - * Access to ACM Private CA.

- * - * - *

ACM Private CA assets that are stored in Amazon S3 can be protected with encryption. + * 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.

+ * */ public createCertificateAuthorityAuditReport( args: CreateCertificateAuthorityAuditReportCommandInput, @@ -228,9 +227,9 @@ export class ACMPCA extends ACMPCAClient { } /** - *

Grants one or more permissions on a private CA to the AWS Certificate Manager (ACM) service + *

Grants one or more permissions on a private CA to the Certificate Manager (ACM) service * principal (acm.amazonaws.com). These permissions allow ACM to issue and - * renew ACM certificates that reside in the same AWS account as the CA.

+ * renew ACM certificates that reside in the same Amazon Web Services account as the CA.

*

You can list current permissions with the ListPermissions action and * revoke them with the DeletePermission action.

*

@@ -252,7 +251,7 @@ export class ACMPCA extends ACMPCAClient { * the ACM certificate owner must set up a resource-based policy to enable * cross-account issuance and renewals. For more information, see * Using a Resource - * Based Policy with ACM Private CA.

+ * Based Policy with Amazon Web Services Private CA.

* * */ @@ -297,8 +296,8 @@ export class ACMPCA extends ACMPCAClient { * To do this, call the UpdateCertificateAuthority action and set the CertificateAuthorityStatus parameter to DISABLED.

*

Additionally, you can delete a CA if you are waiting for it to be created (that is, * the status of the CA is CREATING). You can also delete it if the CA has - * been created but you haven't yet imported the signed certificate into ACM Private CA (that is, - * the status of the CA is PENDING_CERTIFICATE).

+ * been created but you haven't yet imported the signed certificate into Amazon Web Services Private CA (that + * is, the status of the CA is PENDING_CERTIFICATE).

*

When you successfully call DeleteCertificateAuthority, the CA's status changes to * DELETED. However, the CA won't be permanently deleted until the restoration * period has passed. By default, if you do not set the @@ -337,14 +336,14 @@ export class ACMPCA extends ACMPCAClient { } /** - *

Revokes permissions on a private CA granted to the AWS Certificate Manager (ACM) service principal + *

Revokes permissions on a private CA granted to the Certificate Manager (ACM) service principal * (acm.amazonaws.com).

*

These permissions allow ACM to issue and renew ACM certificates that reside in the - * same AWS account as the CA. If you revoke these permissions, ACM will no longer + * same Amazon Web Services account as the CA. If you revoke these permissions, ACM will no longer * renew the affected certificates automatically.

*

Permissions can be granted with the CreatePermission action and * listed with the ListPermissions action.

- *

+ *

* About Permissions *

* */ @@ -400,9 +399,9 @@ export class ACMPCA extends ACMPCAClient { *

Deletes the resource-based policy attached to a private CA. Deletion will remove any * access that the policy has granted. If there is no policy attached to the private CA, * this action will return successful.

- *

If you delete a policy that was applied through AWS Resource Access Manager (RAM), the - * CA will be removed from all shares in which it was included.

- *

The AWS Certificate Manager Service Linked Role that the policy supports is not affected when you + *

If you delete a policy that was applied through Amazon Web Services Resource Access Manager (RAM), + * the CA will be removed from all shares in which it was included.

+ *

The Certificate Manager Service Linked Role that the policy supports is not affected when you * delete the policy.

*

The current policy can be shown with GetPolicy and updated with PutPolicy.

*

@@ -410,24 +409,24 @@ export class ACMPCA extends ACMPCAClient { *

*