diff --git a/CHANGELOG.md b/CHANGELOG.md index 8938b6edf9..2ba301b14b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,54 @@ +0.39.0 (March 17, 2022) +======================= +**Breaking Changes:** +- ⚠ ([aws-sdk-rust#406](https://github.com/awslabs/aws-sdk-rust/issues/406)) `aws_types::config::Config` has been renamed to `aws_types:sdk_config::SdkConfig`. This is to better differentiate it + from service-specific configs like `aws_s3_sdk::Config`. If you were creating shared configs with + `aws_config::load_from_env()`, then you don't have to do anything. If you were directly referring to a shared config, + update your `use` statements and `struct` names. + + _Before:_ + ```rust + use aws_types::config::Config; + + fn main() { + let config = Config::builder() + // config builder methods... + .build() + .await; + } + ``` + + _After:_ + ```rust + use aws_types::SdkConfig; + + fn main() { + let config = SdkConfig::builder() + // config builder methods... + .build() + .await; + } + ``` +- ⚠ ([smithy-rs#724](https://github.com/awslabs/smithy-rs/issues/724)) Timeout configuration has been refactored a bit. If you were setting timeouts through environment variables or an AWS + profile, then you shouldn't need to change anything. Take note, however, that we don't currently support HTTP connect, + read, write, or TLS negotiation timeouts. If you try to set any of those timeouts in your profile or environment, we'll + log a warning explaining that those timeouts don't currently do anything. + + If you were using timeouts programmatically, + you'll need to update your code. In previous versions, timeout configuration was stored in a single `TimeoutConfig` + struct. In this new version, timeouts have been broken up into several different config structs that are then collected + in a `timeout::Config` struct. As an example, to get the API per-attempt timeout in previous versions you would access + it with `.api_call_attempt_timeout()` and in this new version you would access it with + `.api.call_attempt_timeout()`. We also made some unimplemented timeouts inaccessible in order to + avoid giving users the impression that setting them had an effect. We plan to re-introduce them once they're made + functional in a future update. + +**New this release:** +- ([smithy-rs#1225](https://github.com/awslabs/smithy-rs/issues/1225)) `DynMiddleware` is now `clone`able +- ([smithy-rs#1257](https://github.com/awslabs/smithy-rs/issues/1257)) HTTP request property bag now contains list of desired HTTP versions to use when making requests. This list is not currently used but will be in an upcoming update. + + 0.38.0 (Februrary 24, 2022) =========================== **Breaking Changes:** diff --git a/CHANGELOG.next.toml b/CHANGELOG.next.toml index 60dc68128b..72d79628e7 100644 --- a/CHANGELOG.next.toml +++ b/CHANGELOG.next.toml @@ -10,132 +10,3 @@ # references = ["smithy-rs#920"] # meta = { "breaking" = false, "tada" = false, "bug" = false } # author = "rcoh" - -[[smithy-rs]] -message = "`DynMiddleware` is now `clone`able" -references = ["smithy-rs#1225"] -meta = { "breaking" = false, "tada" = false, "bug" = false } -author = "Velfi" - -[[aws-sdk-rust]] -message = """ -`aws_types::config::Config` has been renamed to `aws_types::sdk_config::SdkConfig`. This is to better differentiate it -from service-specific configs like `aws_sdk_s3::Config`. If you were creating shared configs with -`aws_config::load_from_env()`, then you don't have to do anything. If you were directly referring to a shared config, -update your `use` statements and `struct` names. - -_Before:_ -```rust -use aws_types::config::Config; - -fn main() { - let config = Config::builder() - // config builder methods... - .build() - .await; -} -``` - -_After:_ -```rust -// We re-export this type from the root module so it's easier to reference -use aws_types::SdkConfig; - -fn main() { - let config = SdkConfig::builder() - // config builder methods... - .build() - .await; -} -``` -""" -references = ["aws-sdk-rust#406"] -meta = { "breaking" = true, "tada" = false, "bug" = false } -author = "Velfi" - -[[smithy-rs]] -message = """ -`aws_types::config::Config` has been renamed to `aws_types:sdk_config::SdkConfig`. This is to better differentiate it -from service-specific configs like `aws_s3_sdk::Config`. If you were creating shared configs with -`aws_config::load_from_env()`, then you don't have to do anything. If you were directly referring to a shared config, -update your `use` statements and `struct` names. - -_Before:_ -```rust -use aws_types::config::Config; - -fn main() { - let config = Config::builder() - // config builder methods... - .build() - .await; -} -``` - -_After:_ -```rust -use aws_types::SdkConfig; - -fn main() { - let config = SdkConfig::builder() - // config builder methods... - .build() - .await; -} -``` -""" -references = ["aws-sdk-rust#406"] -meta = { "breaking" = true, "tada" = false, "bug" = false } -author = "Velfi" - -[[aws-sdk-rust]] -message = "Enable presigning for S3 operations UploadPart and DeleteObject" -references = ["aws-sdk-rust#475", "aws-sdk-rust#473"] -meta = { "breaking" = false, "tada" = true, "bug" = false } -author = "rcoh" - -[[smithy-rs]] -message = """ -Timeout configuration has been refactored a bit. If you were setting timeouts through environment variables or an AWS -profile, then you shouldn't need to change anything. Take note, however, that we don't currently support HTTP connect, -read, write, or TLS negotiation timeouts. If you try to set any of those timeouts in your profile or environment, we'll -log a warning explaining that those timeouts don't currently do anything. - -If you were using timeouts programmatically, -you'll need to update your code. In previous versions, timeout configuration was stored in a single `TimeoutConfig` -struct. In this new version, timeouts have been broken up into several different config structs that are then collected -in a `timeout::Config` struct. As an example, to get the API per-attempt timeout in previous versions you would access -it with `.api_call_attempt_timeout()` and in this new version you would access it with -`.api.call_attempt_timeout()`. We also made some unimplemented timeouts inaccessible in order to -avoid giving users the impression that setting them had an effect. We plan to re-introduce them once they're made -functional in a future update. -""" -references = ["smithy-rs#724"] -meta = { "breaking" = true, "tada" = false, "bug" = false } -author = "Velfi" - -[[aws-sdk-rust]] -message = """ -Timeout configuration has been refactored a bit. If you were setting timeouts through environment variables or an AWS -profile, then you shouldn't need to change anything. Take note, however, that we don't currently support HTTP connect, -read, write, or TLS negotiation timeouts. If you try to set any of those timeouts in your profile or environment, we'll -log a warning explaining that those timeouts don't currently do anything. - -If you were using timeouts programmatically, -you'll need to update your code. In previous versions, timeout configuration was stored in a single `TimeoutConfig` -struct. In this new version, timeouts have been broken up into several different config structs that are then collected -in a `timeout::Config` struct. As an example, to get the API per-attempt timeout in previous versions you would access -it with `.api_call_attempt_timeout()` and in this new version you would access it with -`.api.call_attempt_timeout()`. We also made some unimplemented timeouts inaccessible in order to -avoid giving users the impression that setting them had an effect. We plan to re-introduce them once they're made -functional in a future update. -""" -references = ["smithy-rs#724"] -meta = { "breaking" = true, "tada" = false, "bug" = false } -author = "Velfi" - -[[smithy-rs]] -message = "HTTP request property bag now contains list of desired HTTP versions to use when making requests. This list is not currently used but will be in an upcoming update." -references = ["smithy-rs#1257"] -meta = { "breaking" = false, "tada" = false, "bug" = false } -author = "Velfi" diff --git a/aws/SDK_CHANGELOG.md b/aws/SDK_CHANGELOG.md index 4f2c0559b6..fb2dd2c411 100644 --- a/aws/SDK_CHANGELOG.md +++ b/aws/SDK_CHANGELOG.md @@ -1,4 +1,54 @@ +0.9.0 (March 17, 2022) +====================== +**Breaking Changes:** +- ⚠ ([aws-sdk-rust#406](https://github.com/awslabs/aws-sdk-rust/issues/406)) `aws_types::config::Config` has been renamed to `aws_types::sdk_config::SdkConfig`. This is to better differentiate it + from service-specific configs like `aws_sdk_s3::Config`. If you were creating shared configs with + `aws_config::load_from_env()`, then you don't have to do anything. If you were directly referring to a shared config, + update your `use` statements and `struct` names. + + _Before:_ + ```rust + use aws_types::config::Config; + + fn main() { + let config = Config::builder() + // config builder methods... + .build() + .await; + } + ``` + + _After:_ + ```rust + // We re-export this type from the root module so it's easier to reference + use aws_types::SdkConfig; + + fn main() { + let config = SdkConfig::builder() + // config builder methods... + .build() + .await; + } + ``` +- ⚠ ([smithy-rs#724](https://github.com/awslabs/smithy-rs/issues/724)) Timeout configuration has been refactored a bit. If you were setting timeouts through environment variables or an AWS + profile, then you shouldn't need to change anything. Take note, however, that we don't currently support HTTP connect, + read, write, or TLS negotiation timeouts. If you try to set any of those timeouts in your profile or environment, we'll + log a warning explaining that those timeouts don't currently do anything. + + If you were using timeouts programmatically, + you'll need to update your code. In previous versions, timeout configuration was stored in a single `TimeoutConfig` + struct. In this new version, timeouts have been broken up into several different config structs that are then collected + in a `timeout::Config` struct. As an example, to get the API per-attempt timeout in previous versions you would access + it with `.api_call_attempt_timeout()` and in this new version you would access it with + `.api.call_attempt_timeout()`. We also made some unimplemented timeouts inaccessible in order to + avoid giving users the impression that setting them had an effect. We plan to re-introduce them once they're made + functional in a future update. + +**New this release:** +- 🎉 ([aws-sdk-rust#475](https://github.com/awslabs/aws-sdk-rust/issues/475), [aws-sdk-rust#473](https://github.com/awslabs/aws-sdk-rust/issues/473)) Enable presigning for S3 operations UploadPart and DeleteObject + + 0.8.0 (Februrary 24, 2022) ========================== **Breaking Changes:** diff --git a/aws/sdk-codegen/src/main/resources/software/amazon/smithy/rustsdk/endpoints.json b/aws/sdk-codegen/src/main/resources/software/amazon/smithy/rustsdk/endpoints.json index 29eaae2a4b..298a8f994c 100644 --- a/aws/sdk-codegen/src/main/resources/software/amazon/smithy/rustsdk/endpoints.json +++ b/aws/sdk-codegen/src/main/resources/software/amazon/smithy/rustsdk/endpoints.json @@ -3,7 +3,20 @@ "defaults" : { "hostname" : "{service}.{region}.{dnsSuffix}", "protocols" : [ "https" ], - "signatureVersions" : [ "v4" ] + "signatureVersions" : [ "v4" ], + "variants" : [ { + "dnsSuffix" : "amazonaws.com", + "hostname" : "{service}-fips.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + }, { + "dnsSuffix" : "api.aws", + "hostname" : "{service}-fips.{region}.{dnsSuffix}", + "tags" : [ "dualstack", "fips" ] + }, { + "dnsSuffix" : "api.aws", + "hostname" : "{service}.{region}.{dnsSuffix}", + "tags" : [ "dualstack" ] + } ] }, "dnsSuffix" : "amazonaws.com", "partition" : "aws", @@ -22,6 +35,9 @@ "ap-northeast-2" : { "description" : "Asia Pacific (Seoul)" }, + "ap-northeast-3" : { + "description" : "Asia Pacific (Osaka)" + }, "ap-south-1" : { "description" : "Asia Pacific (Mumbai)" }, @@ -31,6 +47,9 @@ "ap-southeast-2" : { "description" : "Asia Pacific (Sydney)" }, + "ap-southeast-3" : { + "description" : "Asia Pacific (Jakarta)" + }, "ca-central-1" : { "description" : "Canada (Central)" }, @@ -83,10 +102,17 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, - "ca-central-1" : { }, + "ap-southeast-3" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "access-analyzer-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "eu-central-1" : { }, "eu-north-1" : { }, "eu-south-1" : { }, @@ -97,54 +123,99 @@ "credentialScope" : { "region" : "ca-central-1" }, + "deprecated" : true, "hostname" : "access-analyzer-fips.ca-central-1.amazonaws.com" }, "fips-us-east-1" : { "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "access-analyzer-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "access-analyzer-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "access-analyzer-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "access-analyzer-fips.us-west-2.amazonaws.com" }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "access-analyzer-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "access-analyzer-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "access-analyzer-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "access-analyzer-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, + "account" : { + "endpoints" : { + "aws-global" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "account.us-east-1.amazonaws.com" + } + }, + "isRegionalized" : false, + "partitionEndpoint" : "aws-global" + }, "acm" : { "endpoints" : { "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, - "ca-central-1" : { }, + "ap-southeast-3" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "acm-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "ca-central-1-fips" : { "credentialScope" : { "region" : "ca-central-1" }, + "deprecated" : true, "hostname" : "acm-fips.ca-central-1.amazonaws.com" }, "eu-central-1" : { }, @@ -155,32 +226,56 @@ "eu-west-3" : { }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, + "us-east-1" : { + "variants" : [ { + "hostname" : "acm-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-east-1-fips" : { "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "acm-fips.us-east-1.amazonaws.com" }, - "us-east-2" : { }, + "us-east-2" : { + "variants" : [ { + "hostname" : "acm-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-east-2-fips" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "acm-fips.us-east-2.amazonaws.com" }, - "us-west-1" : { }, + "us-west-1" : { + "variants" : [ { + "hostname" : "acm-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-west-1-fips" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "acm-fips.us-west-1.amazonaws.com" }, - "us-west-2" : { }, + "us-west-2" : { + "variants" : [ { + "hostname" : "acm-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-west-2-fips" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "acm-fips.us-west-2.amazonaws.com" } } @@ -194,10 +289,16 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, - "ca-central-1" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "acm-pca-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "eu-central-1" : { }, "eu-north-1" : { }, "eu-south-1" : { }, @@ -208,34 +309,138 @@ "credentialScope" : { "region" : "ca-central-1" }, + "deprecated" : true, "hostname" : "acm-pca-fips.ca-central-1.amazonaws.com" }, "fips-us-east-1" : { "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "acm-pca-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "acm-pca-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "acm-pca-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "acm-pca-fips.us-west-2.amazonaws.com" }, "me-south-1" : { }, "sa-east-1" : { }, + "us-east-1" : { + "variants" : [ { + "hostname" : "acm-pca-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "acm-pca-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "acm-pca-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "acm-pca-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, + "airflow" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-2" : { } + } + }, + "amplify" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-south-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "amplifybackend" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-2" : { } + } + }, + "amplifyuibuilder" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, "us-east-1" : { }, "us-east-2" : { }, "us-west-1" : { }, @@ -263,13 +468,67 @@ "eu-west-3" : { }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "api.detective-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-1-fips" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "api.detective-fips.us-east-1.amazonaws.com" + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "api.detective-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2-fips" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "hostname" : "api.detective-fips.us-east-2.amazonaws.com" + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "api.detective-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1-fips" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "deprecated" : true, + "hostname" : "api.detective-fips.us-west-1.amazonaws.com" + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "api.detective-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2-fips" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "hostname" : "api.detective-fips.us-west-2.amazonaws.com" + } } }, "api.ecr" : { + "defaults" : { + "variants" : [ { + "hostname" : "ecr-fips.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] + }, "endpoints" : { "af-south-1" : { "credentialScope" : { @@ -295,6 +554,12 @@ }, "hostname" : "api.ecr.ap-northeast-2.amazonaws.com" }, + "ap-northeast-3" : { + "credentialScope" : { + "region" : "ap-northeast-3" + }, + "hostname" : "api.ecr.ap-northeast-3.amazonaws.com" + }, "ap-south-1" : { "credentialScope" : { "region" : "ap-south-1" @@ -313,12 +578,58 @@ }, "hostname" : "api.ecr.ap-southeast-2.amazonaws.com" }, + "ap-southeast-3" : { + "credentialScope" : { + "region" : "ap-southeast-3" + }, + "hostname" : "api.ecr.ap-southeast-3.amazonaws.com" + }, "ca-central-1" : { "credentialScope" : { "region" : "ca-central-1" }, "hostname" : "api.ecr.ca-central-1.amazonaws.com" }, + "dkr-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "variants" : [ { + "hostname" : "ecr-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "dkr-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "variants" : [ { + "hostname" : "ecr-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "dkr-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "deprecated" : true, + "variants" : [ { + "hostname" : "ecr-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "dkr-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "variants" : [ { + "hostname" : "ecr-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "eu-central-1" : { "credentialScope" : { "region" : "eu-central-1" @@ -359,48 +670,56 @@ "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "ecr-fips.us-east-1.amazonaws.com" }, "fips-dkr-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "ecr-fips.us-east-2.amazonaws.com" }, "fips-dkr-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "ecr-fips.us-west-1.amazonaws.com" }, "fips-dkr-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "ecr-fips.us-west-2.amazonaws.com" }, "fips-us-east-1" : { "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "ecr-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "ecr-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "ecr-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "ecr-fips.us-west-2.amazonaws.com" }, "me-south-1" : { @@ -419,25 +738,41 @@ "credentialScope" : { "region" : "us-east-1" }, - "hostname" : "api.ecr.us-east-1.amazonaws.com" + "hostname" : "api.ecr.us-east-1.amazonaws.com", + "variants" : [ { + "hostname" : "ecr-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] }, "us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, - "hostname" : "api.ecr.us-east-2.amazonaws.com" + "hostname" : "api.ecr.us-east-2.amazonaws.com", + "variants" : [ { + "hostname" : "ecr-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] }, "us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, - "hostname" : "api.ecr.us-west-1.amazonaws.com" + "hostname" : "api.ecr.us-west-1.amazonaws.com", + "variants" : [ { + "hostname" : "ecr-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] }, "us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, - "hostname" : "api.ecr.us-west-2.amazonaws.com" + "hostname" : "api.ecr.us-west-2.amazonaws.com", + "variants" : [ { + "hostname" : "ecr-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] } } }, @@ -463,6 +798,105 @@ } } }, + "api.fleethub.iot" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "api.fleethub.iot-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "fips-ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "deprecated" : true, + "hostname" : "api.fleethub.iot-fips.ca-central-1.amazonaws.com" + }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "api.fleethub.iot-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "hostname" : "api.fleethub.iot-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "hostname" : "api.fleethub.iot-fips.us-west-2.amazonaws.com" + }, + "us-east-1" : { + "variants" : [ { + "hostname" : "api.fleethub.iot-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "api.fleethub.iot-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "api.fleethub.iot-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, + "api.iotwireless" : { + "endpoints" : { + "ap-northeast-1" : { + "credentialScope" : { + "region" : "ap-northeast-1" + }, + "hostname" : "api.iotwireless.ap-northeast-1.amazonaws.com" + }, + "ap-southeast-2" : { + "credentialScope" : { + "region" : "ap-southeast-2" + }, + "hostname" : "api.iotwireless.ap-southeast-2.amazonaws.com" + }, + "eu-west-1" : { + "credentialScope" : { + "region" : "eu-west-1" + }, + "hostname" : "api.iotwireless.eu-west-1.amazonaws.com" + }, + "us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "api.iotwireless.us-east-1.amazonaws.com" + }, + "us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "api.iotwireless.us-west-2.amazonaws.com" + } + } + }, "api.mediatailor" : { "endpoints" : { "ap-northeast-1" : { }, @@ -486,11 +920,18 @@ } }, "api.sagemaker" : { + "defaults" : { + "variants" : [ { + "hostname" : "api-fips.sagemaker.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] + }, "endpoints" : { "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, @@ -503,42 +944,192 @@ "eu-west-3" : { }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, + "us-east-1" : { + "variants" : [ { + "hostname" : "api-fips.sagemaker.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-east-1-fips" : { "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "api-fips.sagemaker.us-east-1.amazonaws.com" }, - "us-east-2" : { }, + "us-east-2" : { + "variants" : [ { + "hostname" : "api-fips.sagemaker.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-east-2-fips" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "api-fips.sagemaker.us-east-2.amazonaws.com" }, - "us-west-1" : { }, + "us-west-1" : { + "variants" : [ { + "hostname" : "api-fips.sagemaker.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-west-1-fips" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "api-fips.sagemaker.us-west-1.amazonaws.com" }, - "us-west-2" : { }, + "us-west-2" : { + "variants" : [ { + "hostname" : "api-fips.sagemaker.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-west-2-fips" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "api-fips.sagemaker.us-west-2.amazonaws.com" } } }, + "api.tunneling.iot" : { + "defaults" : { + "variants" : [ { + "hostname" : "api.tunneling.iot-fips.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] + }, + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "api.tunneling.iot-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "fips-ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "deprecated" : true, + "hostname" : "api.tunneling.iot-fips.ca-central-1.amazonaws.com" + }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "api.tunneling.iot-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "hostname" : "api.tunneling.iot-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "deprecated" : true, + "hostname" : "api.tunneling.iot-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "hostname" : "api.tunneling.iot-fips.us-west-2.amazonaws.com" + }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { + "variants" : [ { + "hostname" : "api.tunneling.iot-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "api.tunneling.iot-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "api.tunneling.iot-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "api.tunneling.iot-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, "apigateway" : { "endpoints" : { "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-south-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "app-integrations" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-west-2" : { }, + "us-east-1" : { }, + "us-west-2" : { } + } + }, + "appconfigdata" : { + "endpoints" : { + "af-south-1" : { }, + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, @@ -559,6 +1150,7 @@ }, "appflow" : { "endpoints" : { + "af-south-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, "ap-south-1" : { }, @@ -585,6 +1177,33 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ap-southeast-3" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-south-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "applicationinsights" : { + "endpoints" : { + "af-south-1" : { }, + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, @@ -605,6 +1224,7 @@ }, "appmesh" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -626,6 +1246,51 @@ "us-west-2" : { } } }, + "apprunner" : { + "endpoints" : { + "ap-northeast-1" : { }, + "eu-west-1" : { }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "apprunner-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "hostname" : "apprunner-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "hostname" : "apprunner-fips.us-west-2.amazonaws.com" + }, + "us-east-1" : { + "variants" : [ { + "hostname" : "apprunner-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "apprunner-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "apprunner-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, "appstream2" : { "defaults" : { "credentialScope" : { @@ -641,14 +1306,40 @@ "ap-southeast-2" : { }, "eu-central-1" : { }, "eu-west-1" : { }, + "eu-west-2" : { }, "fips" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "appstream2-fips.us-west-2.amazonaws.com" }, - "us-east-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "appstream2-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-1-fips" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "appstream2-fips.us-east-1.amazonaws.com" + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "appstream2-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2-fips" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "hostname" : "appstream2-fips.us-west-2.amazonaws.com" + } } }, "appsync" : { @@ -656,6 +1347,7 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, @@ -674,12 +1366,29 @@ "us-west-2" : { } } }, + "aps" : { + "defaults" : { + "protocols" : [ "https" ] + }, + "endpoints" : { + "ap-northeast-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-2" : { } + } + }, "athena" : { "endpoints" : { "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, @@ -690,8 +1399,72 @@ "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "athena-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "hostname" : "athena-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "deprecated" : true, + "hostname" : "athena-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "hostname" : "athena-fips.us-west-2.amazonaws.com" + }, "me-south-1" : { }, "sa-east-1" : { }, + "us-east-1" : { + "variants" : [ { + "hostname" : "athena-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "athena-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "athena-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "athena-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, + "auditmanager" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, "us-east-1" : { }, "us-east-2" : { }, "us-west-1" : { }, @@ -707,9 +1480,11 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-3" : { }, "ca-central-1" : { }, "eu-central-1" : { }, "eu-north-1" : { }, @@ -734,9 +1509,11 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-3" : { }, "ca-central-1" : { }, "eu-central-1" : { }, "eu-north-1" : { }, @@ -758,9 +1535,11 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-3" : { }, "ca-central-1" : { }, "eu-central-1" : { }, "eu-north-1" : { }, @@ -777,10 +1556,18 @@ } }, "batch" : { + "defaults" : { + "variants" : [ { + "hostname" : "fips.batch.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] + }, "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, @@ -795,30 +1582,74 @@ "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "fips.batch.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "fips.batch.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "fips.batch.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "fips.batch.us-west-2.amazonaws.com" }, "me-south-1" : { }, "sa-east-1" : { }, + "us-east-1" : { + "variants" : [ { + "hostname" : "fips.batch.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "fips.batch.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "fips.batch.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "fips.batch.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, + "billingconductor" : { + "endpoints" : { + "aws-global" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "billingconductor.us-east-1.amazonaws.com" + } + }, + "isRegionalized" : false, + "partitionEndpoint" : "aws-global" + }, + "braket" : { + "endpoints" : { + "eu-west-2" : { }, "us-east-1" : { }, - "us-east-2" : { }, "us-west-1" : { }, "us-west-2" : { } } @@ -849,8 +1680,7 @@ }, "chime" : { "defaults" : { - "protocols" : [ "https" ], - "sslCommonName" : "service.chime.aws.amazon.com" + "protocols" : [ "https" ] }, "endpoints" : { "aws-global" : { @@ -866,9 +1696,11 @@ }, "cloud9" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, @@ -887,15 +1719,101 @@ "us-west-2" : { } } }, - "clouddirectory" : { + "cloudcontrolapi" : { "endpoints" : { + "af-south-1" : { }, + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-northeast-3" : { }, + "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, - "ca-central-1" : { }, + "ap-southeast-3" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "cloudcontrolapi-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-south-1" : { }, "eu-west-1" : { }, "eu-west-2" : { }, - "us-east-1" : { }, + "eu-west-3" : { }, + "fips-ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "deprecated" : true, + "hostname" : "cloudcontrolapi-fips.ca-central-1.amazonaws.com" + }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "cloudcontrolapi-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "hostname" : "cloudcontrolapi-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "deprecated" : true, + "hostname" : "cloudcontrolapi-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "hostname" : "cloudcontrolapi-fips.us-west-2.amazonaws.com" + }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { + "variants" : [ { + "hostname" : "cloudcontrolapi-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "cloudcontrolapi-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "cloudcontrolapi-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "cloudcontrolapi-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, + "clouddirectory" : { + "endpoints" : { + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "us-east-1" : { }, "us-east-2" : { }, "us-west-2" : { } } @@ -906,9 +1824,11 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-3" : { }, "ca-central-1" : { }, "eu-central-1" : { }, "eu-north-1" : { }, @@ -918,32 +1838,56 @@ "eu-west-3" : { }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, + "us-east-1" : { + "variants" : [ { + "hostname" : "cloudformation-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-east-1-fips" : { "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "cloudformation-fips.us-east-1.amazonaws.com" }, - "us-east-2" : { }, + "us-east-2" : { + "variants" : [ { + "hostname" : "cloudformation-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-east-2-fips" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "cloudformation-fips.us-east-2.amazonaws.com" }, - "us-west-1" : { }, + "us-west-1" : { + "variants" : [ { + "hostname" : "cloudformation-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-west-1-fips" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "cloudformation-fips.us-west-1.amazonaws.com" }, - "us-west-2" : { }, + "us-west-2" : { + "variants" : [ { + "hostname" : "cloudformation-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-west-2-fips" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "cloudformation-fips.us-west-2.amazonaws.com" } } @@ -963,16 +1907,8 @@ }, "cloudhsm" : { "endpoints" : { - "ap-northeast-1" : { }, - "ap-southeast-1" : { }, - "ap-southeast-2" : { }, - "ca-central-1" : { }, - "eu-central-1" : { }, "eu-west-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-1" : { } } }, "cloudhsmv2" : { @@ -986,6 +1922,7 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, @@ -1024,9 +1961,11 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-3" : { }, "ca-central-1" : { }, "eu-central-1" : { }, "eu-north-1" : { }, @@ -1038,32 +1977,56 @@ "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "cloudtrail-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "cloudtrail-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "cloudtrail-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "cloudtrail-fips.us-west-2.amazonaws.com" }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "cloudtrail-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "cloudtrail-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "cloudtrail-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "cloudtrail-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "codeartifact" : { @@ -1074,7 +2037,10 @@ "ap-southeast-2" : { }, "eu-central-1" : { }, "eu-north-1" : { }, + "eu-south-1" : { }, "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, "us-east-1" : { }, "us-east-2" : { }, "us-west-2" : { } @@ -1082,9 +2048,11 @@ }, "codebuild" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, @@ -1097,45 +2065,83 @@ "eu-west-3" : { }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, + "us-east-1" : { + "variants" : [ { + "hostname" : "codebuild-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-east-1-fips" : { "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "codebuild-fips.us-east-1.amazonaws.com" }, - "us-east-2" : { }, + "us-east-2" : { + "variants" : [ { + "hostname" : "codebuild-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-east-2-fips" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "codebuild-fips.us-east-2.amazonaws.com" }, - "us-west-1" : { }, + "us-west-1" : { + "variants" : [ { + "hostname" : "codebuild-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-west-1-fips" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "codebuild-fips.us-west-1.amazonaws.com" }, - "us-west-2" : { }, + "us-west-2" : { + "variants" : [ { + "hostname" : "codebuild-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-west-2-fips" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "codebuild-fips.us-west-2.amazonaws.com" } } }, "codecommit" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, - "ca-central-1" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "codecommit-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "ca-central-1-fips" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "deprecated" : true, + "hostname" : "codecommit-fips.ca-central-1.amazonaws.com" + }, "eu-central-1" : { }, "eu-north-1" : { }, "eu-south-1" : { }, @@ -1146,14 +2152,63 @@ "credentialScope" : { "region" : "ca-central-1" }, + "deprecated" : true, "hostname" : "codecommit-fips.ca-central-1.amazonaws.com" }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "codecommit-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-1-fips" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "codecommit-fips.us-east-1.amazonaws.com" + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "codecommit-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2-fips" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "hostname" : "codecommit-fips.us-east-2.amazonaws.com" + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "codecommit-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1-fips" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "deprecated" : true, + "hostname" : "codecommit-fips.us-west-1.amazonaws.com" + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "codecommit-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2-fips" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "hostname" : "codecommit-fips.us-west-2.amazonaws.com" + } } }, "codedeploy" : { @@ -1162,9 +2217,11 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-3" : { }, "ca-central-1" : { }, "eu-central-1" : { }, "eu-north-1" : { }, @@ -1174,46 +2231,91 @@ "eu-west-3" : { }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, + "us-east-1" : { + "variants" : [ { + "hostname" : "codedeploy-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-east-1-fips" : { "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "codedeploy-fips.us-east-1.amazonaws.com" }, - "us-east-2" : { }, + "us-east-2" : { + "variants" : [ { + "hostname" : "codedeploy-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-east-2-fips" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "codedeploy-fips.us-east-2.amazonaws.com" }, - "us-west-1" : { }, + "us-west-1" : { + "variants" : [ { + "hostname" : "codedeploy-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-west-1-fips" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "codedeploy-fips.us-west-1.amazonaws.com" }, - "us-west-2" : { }, + "us-west-2" : { + "variants" : [ { + "hostname" : "codedeploy-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-west-2-fips" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "codedeploy-fips.us-west-2.amazonaws.com" } } }, + "codeguru-reviewer" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-2" : { } + } + }, "codepipeline" : { "endpoints" : { + "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, - "ca-central-1" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "codepipeline-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "eu-central-1" : { }, "eu-north-1" : { }, + "eu-south-1" : { }, "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, @@ -1221,37 +2323,62 @@ "credentialScope" : { "region" : "ca-central-1" }, + "deprecated" : true, "hostname" : "codepipeline-fips.ca-central-1.amazonaws.com" }, "fips-us-east-1" : { "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "codepipeline-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "codepipeline-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "codepipeline-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "codepipeline-fips.us-west-2.amazonaws.com" }, "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "codepipeline-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "codepipeline-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "codepipeline-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "codepipeline-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "codestar" : { @@ -1308,23 +2435,44 @@ "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "cognito-identity-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "cognito-identity-fips.us-east-2.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "cognito-identity-fips.us-west-2.amazonaws.com" }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-2" : { } + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { + "variants" : [ { + "hostname" : "cognito-identity-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "cognito-identity-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { }, + "us-west-2" : { + "variants" : [ { + "hostname" : "cognito-identity-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "cognito-idp" : { @@ -1344,23 +2492,56 @@ "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "cognito-idp-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "cognito-idp-fips.us-east-2.amazonaws.com" }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "deprecated" : true, + "hostname" : "cognito-idp-fips.us-west-1.amazonaws.com" + }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "cognito-idp-fips.us-west-2.amazonaws.com" }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-2" : { } + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { + "variants" : [ { + "hostname" : "cognito-idp-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "cognito-idp-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "cognito-idp-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "cognito-idp-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "cognito-sync" : { @@ -1396,23 +2577,41 @@ "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "comprehend-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "comprehend-fips.us-east-2.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "comprehend-fips.us-west-2.amazonaws.com" }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "comprehend-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "comprehend-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "comprehend-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "comprehendmedical" : { @@ -1425,78 +2624,237 @@ "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "comprehendmedical-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "comprehendmedical-fips.us-east-2.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "comprehendmedical-fips.us-west-2.amazonaws.com" }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "comprehendmedical-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "comprehendmedical-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "comprehendmedical-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, - "config" : { + "compute-optimizer" : { "endpoints" : { - "af-south-1" : { }, - "ap-east-1" : { }, - "ap-northeast-1" : { }, - "ap-northeast-2" : { }, - "ap-south-1" : { }, - "ap-southeast-1" : { }, - "ap-southeast-2" : { }, - "ca-central-1" : { }, - "eu-central-1" : { }, - "eu-north-1" : { }, - "eu-south-1" : { }, - "eu-west-1" : { }, - "eu-west-2" : { }, - "eu-west-3" : { }, - "fips-us-east-1" : { + "ap-northeast-1" : { "credentialScope" : { - "region" : "us-east-1" + "region" : "ap-northeast-1" }, - "hostname" : "config-fips.us-east-1.amazonaws.com" + "hostname" : "compute-optimizer.ap-northeast-1.amazonaws.com" }, - "fips-us-east-2" : { + "ap-northeast-2" : { "credentialScope" : { - "region" : "us-east-2" + "region" : "ap-northeast-2" }, - "hostname" : "config-fips.us-east-2.amazonaws.com" + "hostname" : "compute-optimizer.ap-northeast-2.amazonaws.com" }, - "fips-us-west-1" : { + "ap-south-1" : { "credentialScope" : { - "region" : "us-west-1" + "region" : "ap-south-1" }, - "hostname" : "config-fips.us-west-1.amazonaws.com" + "hostname" : "compute-optimizer.ap-south-1.amazonaws.com" + }, + "ap-southeast-1" : { + "credentialScope" : { + "region" : "ap-southeast-1" + }, + "hostname" : "compute-optimizer.ap-southeast-1.amazonaws.com" + }, + "ap-southeast-2" : { + "credentialScope" : { + "region" : "ap-southeast-2" + }, + "hostname" : "compute-optimizer.ap-southeast-2.amazonaws.com" + }, + "ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "hostname" : "compute-optimizer.ca-central-1.amazonaws.com" + }, + "eu-central-1" : { + "credentialScope" : { + "region" : "eu-central-1" + }, + "hostname" : "compute-optimizer.eu-central-1.amazonaws.com" + }, + "eu-north-1" : { + "credentialScope" : { + "region" : "eu-north-1" + }, + "hostname" : "compute-optimizer.eu-north-1.amazonaws.com" + }, + "eu-west-1" : { + "credentialScope" : { + "region" : "eu-west-1" + }, + "hostname" : "compute-optimizer.eu-west-1.amazonaws.com" + }, + "eu-west-2" : { + "credentialScope" : { + "region" : "eu-west-2" + }, + "hostname" : "compute-optimizer.eu-west-2.amazonaws.com" + }, + "eu-west-3" : { + "credentialScope" : { + "region" : "eu-west-3" + }, + "hostname" : "compute-optimizer.eu-west-3.amazonaws.com" + }, + "sa-east-1" : { + "credentialScope" : { + "region" : "sa-east-1" + }, + "hostname" : "compute-optimizer.sa-east-1.amazonaws.com" + }, + "us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "compute-optimizer.us-east-1.amazonaws.com" + }, + "us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "compute-optimizer.us-east-2.amazonaws.com" + }, + "us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "compute-optimizer.us-west-1.amazonaws.com" + }, + "us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "compute-optimizer.us-west-2.amazonaws.com" + } + } + }, + "config" : { + "endpoints" : { + "af-south-1" : { }, + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-northeast-3" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ap-southeast-3" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-south-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "config-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "hostname" : "config-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "deprecated" : true, + "hostname" : "config-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "config-fips.us-west-2.amazonaws.com" }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "config-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "config-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "config-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "config-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "connect" : { "endpoints" : { + "af-south-1" : { }, "ap-northeast-1" : { }, + "ap-northeast-2" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-west-2" : { }, + "us-east-1" : { }, + "us-west-2" : { } + } + }, + "contact-lens" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, "eu-central-1" : { }, "eu-west-2" : { }, "us-east-1" : { }, @@ -1522,30 +2880,195 @@ "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, - "ca-central-1" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "data.iot-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "fips-ca-central-1" : { + "credentialScope" : { + "service" : "iotdata" + }, + "deprecated" : true, + "hostname" : "data.iot-fips.ca-central-1.amazonaws.com" + }, + "fips-us-east-1" : { + "credentialScope" : { + "service" : "iotdata" + }, + "deprecated" : true, + "hostname" : "data.iot-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "service" : "iotdata" + }, + "deprecated" : true, + "hostname" : "data.iot-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "service" : "iotdata" + }, + "deprecated" : true, + "hostname" : "data.iot-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "service" : "iotdata" + }, + "deprecated" : true, + "hostname" : "data.iot-fips.us-west-2.amazonaws.com" + }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { + "variants" : [ { + "hostname" : "data.iot-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "data.iot-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "data.iot-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "data.iot-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, + "data.jobs.iot" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "data.jobs.iot-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "eu-central-1" : { }, "eu-north-1" : { }, "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "fips-ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "deprecated" : true, + "hostname" : "data.jobs.iot-fips.ca-central-1.amazonaws.com" + }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "data.jobs.iot-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "hostname" : "data.jobs.iot-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "deprecated" : true, + "hostname" : "data.jobs.iot-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "hostname" : "data.jobs.iot-fips.us-west-2.amazonaws.com" + }, "me-south-1" : { }, "sa-east-1" : { }, + "us-east-1" : { + "variants" : [ { + "hostname" : "data.jobs.iot-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "data.jobs.iot-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "data.jobs.iot-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "data.jobs.iot-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, + "data.mediastore" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-southeast-2" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, "us-west-2" : { } } }, - "data.mediastore" : { + "databrew" : { "endpoints" : { + "af-south-1" : { }, + "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ca-central-1" : { }, "eu-central-1" : { }, "eu-north-1" : { }, + "eu-south-1" : { }, "eu-west-1" : { }, "eu-west-2" : { }, + "eu-west-3" : { }, + "sa-east-1" : { }, "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, "us-west-2" : { } } }, @@ -1579,10 +3102,16 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, - "ca-central-1" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "datasync-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "eu-central-1" : { }, "eu-north-1" : { }, "eu-south-1" : { }, @@ -1593,38 +3122,63 @@ "credentialScope" : { "region" : "ca-central-1" }, + "deprecated" : true, "hostname" : "datasync-fips.ca-central-1.amazonaws.com" }, "fips-us-east-1" : { "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "datasync-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "datasync-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "datasync-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "datasync-fips.us-west-2.amazonaws.com" }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "datasync-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "datasync-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "datasync-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "datasync-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "dax" : { @@ -1655,9 +3209,11 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-3" : { }, "ca-central-1" : { }, "eu-central-1" : { }, "eu-north-1" : { }, @@ -1669,36 +3225,60 @@ "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "directconnect-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "directconnect-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "directconnect-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "directconnect-fips.us-west-2.amazonaws.com" }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } - } - }, - "discovery" : { - "endpoints" : { + "us-east-1" : { + "variants" : [ { + "hostname" : "directconnect-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "directconnect-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "directconnect-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "directconnect-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, + "discovery" : { + "endpoints" : { "ap-northeast-1" : { }, "ap-southeast-2" : { }, "eu-central-1" : { }, @@ -1714,14 +3294,27 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-3" : { }, "ca-central-1" : { }, + "dms" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "deprecated" : true, + "variants" : [ { + "hostname" : "dms-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "dms-fips" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "dms-fips.us-west-1.amazonaws.com" }, "eu-central-1" : { }, @@ -1732,10 +3325,58 @@ "eu-west-3" : { }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "dms-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-1-fips" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "dms-fips.us-east-1.amazonaws.com" + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "dms-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2-fips" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "hostname" : "dms-fips.us-east-2.amazonaws.com" + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "dms-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1-fips" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "deprecated" : true, + "hostname" : "dms-fips.us-west-1.amazonaws.com" + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "dms-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2-fips" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "hostname" : "dms-fips.us-west-2.amazonaws.com" + } } }, "docdb" : { @@ -1826,16 +3467,35 @@ } } }, + "drs" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-2" : { } + } + }, "ds" : { "endpoints" : { "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, - "ca-central-1" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "ds-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "eu-central-1" : { }, "eu-north-1" : { }, "eu-south-1" : { }, @@ -1846,38 +3506,63 @@ "credentialScope" : { "region" : "ca-central-1" }, + "deprecated" : true, "hostname" : "ds-fips.ca-central-1.amazonaws.com" }, "fips-us-east-1" : { "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "ds-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "ds-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "ds-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "ds-fips.us-west-2.amazonaws.com" }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "ds-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "ds-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "ds-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "ds-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "dynamodb" : { @@ -1889,14 +3574,22 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, - "ca-central-1" : { }, + "ap-southeast-3" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "dynamodb-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "ca-central-1-fips" : { "credentialScope" : { "region" : "ca-central-1" }, + "deprecated" : true, "hostname" : "dynamodb-fips.ca-central-1.amazonaws.com" }, "eu-central-1" : { }, @@ -1914,32 +3607,56 @@ }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, + "us-east-1" : { + "variants" : [ { + "hostname" : "dynamodb-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-east-1-fips" : { "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "dynamodb-fips.us-east-1.amazonaws.com" }, - "us-east-2" : { }, + "us-east-2" : { + "variants" : [ { + "hostname" : "dynamodb-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-east-2-fips" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "dynamodb-fips.us-east-2.amazonaws.com" }, - "us-west-1" : { }, + "us-west-1" : { + "variants" : [ { + "hostname" : "dynamodb-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-west-1-fips" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "dynamodb-fips.us-west-1.amazonaws.com" }, - "us-west-2" : { }, + "us-west-2" : { + "variants" : [ { + "hostname" : "dynamodb-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-west-2-fips" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "dynamodb-fips.us-west-2.amazonaws.com" } } @@ -1950,10 +3667,16 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, - "ca-central-1" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "ebs-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "eu-central-1" : { }, "eu-north-1" : { }, "eu-south-1" : { }, @@ -1964,38 +3687,63 @@ "credentialScope" : { "region" : "ca-central-1" }, + "deprecated" : true, "hostname" : "ebs-fips.ca-central-1.amazonaws.com" }, "fips-us-east-1" : { "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "ebs-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "ebs-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "ebs-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "ebs-fips.us-west-2.amazonaws.com" }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "ebs-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "ebs-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "ebs-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "ebs-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "ec2" : { @@ -2007,52 +3755,108 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, - "ap-south-1" : { }, + "ap-northeast-3" : { }, + "ap-south-1" : { + "variants" : [ { + "hostname" : "api.ec2.ap-south-1.aws", + "tags" : [ "dualstack" ] + } ] + }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, - "ca-central-1" : { }, + "ap-southeast-3" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "ec2-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "eu-central-1" : { }, "eu-north-1" : { }, "eu-south-1" : { }, - "eu-west-1" : { }, + "eu-west-1" : { + "variants" : [ { + "hostname" : "api.ec2.eu-west-1.aws", + "tags" : [ "dualstack" ] + } ] + }, "eu-west-2" : { }, "eu-west-3" : { }, "fips-ca-central-1" : { "credentialScope" : { "region" : "ca-central-1" }, + "deprecated" : true, "hostname" : "ec2-fips.ca-central-1.amazonaws.com" }, "fips-us-east-1" : { "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "ec2-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "ec2-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "ec2-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "ec2-fips.us-west-2.amazonaws.com" }, "me-south-1" : { }, - "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "sa-east-1" : { + "variants" : [ { + "hostname" : "api.ec2.sa-east-1.aws", + "tags" : [ "dualstack" ] + } ] + }, + "us-east-1" : { + "variants" : [ { + "hostname" : "api.ec2.us-east-1.aws", + "tags" : [ "dualstack" ] + }, { + "hostname" : "ec2-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "api.ec2.us-east-2.aws", + "tags" : [ "dualstack" ] + }, { + "hostname" : "ec2-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "ec2-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "api.ec2.us-west-2.aws", + "tags" : [ "dualstack" ] + }, { + "hostname" : "ec2-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "ecs" : { @@ -2061,9 +3865,11 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-3" : { }, "ca-central-1" : { }, "eu-central-1" : { }, "eu-north-1" : { }, @@ -2075,43 +3881,72 @@ "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "ecs-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "ecs-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "ecs-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "ecs-fips.us-west-2.amazonaws.com" }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "ecs-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "ecs-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "ecs-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "ecs-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "eks" : { "defaults" : { - "protocols" : [ "http", "https" ] + "protocols" : [ "http", "https" ], + "variants" : [ { + "hostname" : "fips.eks.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] }, "endpoints" : { "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, @@ -2126,32 +3961,56 @@ "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "fips.eks.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "fips.eks.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "fips.eks.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "fips.eks.us-west-2.amazonaws.com" }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "fips.eks.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "fips.eks.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "fips.eks.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "fips.eks.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "elasticache" : { @@ -2160,9 +4019,11 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-3" : { }, "ca-central-1" : { }, "eu-central-1" : { }, "eu-north-1" : { }, @@ -2174,14 +4035,63 @@ "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "elasticache-fips.us-west-1.amazonaws.com" }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "elasticache-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-1-fips" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "elasticache-fips.us-east-1.amazonaws.com" + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "elasticache-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2-fips" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "hostname" : "elasticache-fips.us-east-2.amazonaws.com" + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "elasticache-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1-fips" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "deprecated" : true, + "hostname" : "elasticache-fips.us-west-1.amazonaws.com" + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "elasticache-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2-fips" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "hostname" : "elasticache-fips.us-west-2.amazonaws.com" + } } }, "elasticbeanstalk" : { @@ -2190,6 +4100,7 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, @@ -2204,176 +4115,346 @@ "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "elasticbeanstalk-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "elasticbeanstalk-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "elasticbeanstalk-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "elasticbeanstalk-fips.us-west-2.amazonaws.com" }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "elasticbeanstalk-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "elasticbeanstalk-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "elasticbeanstalk-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "elasticbeanstalk-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "elasticfilesystem" : { "endpoints" : { - "af-south-1" : { }, - "ap-east-1" : { }, - "ap-northeast-1" : { }, - "ap-northeast-2" : { }, - "ap-south-1" : { }, - "ap-southeast-1" : { }, - "ap-southeast-2" : { }, - "ca-central-1" : { }, - "eu-central-1" : { }, - "eu-north-1" : { }, - "eu-south-1" : { }, - "eu-west-1" : { }, - "eu-west-2" : { }, - "eu-west-3" : { }, + "af-south-1" : { + "variants" : [ { + "hostname" : "elasticfilesystem-fips.af-south-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "ap-east-1" : { + "variants" : [ { + "hostname" : "elasticfilesystem-fips.ap-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "ap-northeast-1" : { + "variants" : [ { + "hostname" : "elasticfilesystem-fips.ap-northeast-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "ap-northeast-2" : { + "variants" : [ { + "hostname" : "elasticfilesystem-fips.ap-northeast-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "ap-northeast-3" : { + "variants" : [ { + "hostname" : "elasticfilesystem-fips.ap-northeast-3.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "ap-south-1" : { + "variants" : [ { + "hostname" : "elasticfilesystem-fips.ap-south-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "ap-southeast-1" : { + "variants" : [ { + "hostname" : "elasticfilesystem-fips.ap-southeast-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "ap-southeast-2" : { + "variants" : [ { + "hostname" : "elasticfilesystem-fips.ap-southeast-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "ap-southeast-3" : { + "variants" : [ { + "hostname" : "elasticfilesystem-fips.ap-southeast-3.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "elasticfilesystem-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "eu-central-1" : { + "variants" : [ { + "hostname" : "elasticfilesystem-fips.eu-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "eu-north-1" : { + "variants" : [ { + "hostname" : "elasticfilesystem-fips.eu-north-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "eu-south-1" : { + "variants" : [ { + "hostname" : "elasticfilesystem-fips.eu-south-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "eu-west-1" : { + "variants" : [ { + "hostname" : "elasticfilesystem-fips.eu-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "eu-west-2" : { + "variants" : [ { + "hostname" : "elasticfilesystem-fips.eu-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "eu-west-3" : { + "variants" : [ { + "hostname" : "elasticfilesystem-fips.eu-west-3.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "fips-af-south-1" : { "credentialScope" : { "region" : "af-south-1" }, + "deprecated" : true, "hostname" : "elasticfilesystem-fips.af-south-1.amazonaws.com" }, "fips-ap-east-1" : { "credentialScope" : { "region" : "ap-east-1" }, + "deprecated" : true, "hostname" : "elasticfilesystem-fips.ap-east-1.amazonaws.com" }, "fips-ap-northeast-1" : { "credentialScope" : { "region" : "ap-northeast-1" }, + "deprecated" : true, "hostname" : "elasticfilesystem-fips.ap-northeast-1.amazonaws.com" }, "fips-ap-northeast-2" : { "credentialScope" : { "region" : "ap-northeast-2" }, + "deprecated" : true, "hostname" : "elasticfilesystem-fips.ap-northeast-2.amazonaws.com" }, + "fips-ap-northeast-3" : { + "credentialScope" : { + "region" : "ap-northeast-3" + }, + "deprecated" : true, + "hostname" : "elasticfilesystem-fips.ap-northeast-3.amazonaws.com" + }, "fips-ap-south-1" : { "credentialScope" : { "region" : "ap-south-1" }, + "deprecated" : true, "hostname" : "elasticfilesystem-fips.ap-south-1.amazonaws.com" }, "fips-ap-southeast-1" : { "credentialScope" : { "region" : "ap-southeast-1" }, + "deprecated" : true, "hostname" : "elasticfilesystem-fips.ap-southeast-1.amazonaws.com" }, "fips-ap-southeast-2" : { "credentialScope" : { "region" : "ap-southeast-2" }, + "deprecated" : true, "hostname" : "elasticfilesystem-fips.ap-southeast-2.amazonaws.com" }, + "fips-ap-southeast-3" : { + "credentialScope" : { + "region" : "ap-southeast-3" + }, + "deprecated" : true, + "hostname" : "elasticfilesystem-fips.ap-southeast-3.amazonaws.com" + }, "fips-ca-central-1" : { "credentialScope" : { "region" : "ca-central-1" }, + "deprecated" : true, "hostname" : "elasticfilesystem-fips.ca-central-1.amazonaws.com" }, "fips-eu-central-1" : { "credentialScope" : { "region" : "eu-central-1" }, + "deprecated" : true, "hostname" : "elasticfilesystem-fips.eu-central-1.amazonaws.com" }, "fips-eu-north-1" : { "credentialScope" : { "region" : "eu-north-1" }, + "deprecated" : true, "hostname" : "elasticfilesystem-fips.eu-north-1.amazonaws.com" }, "fips-eu-south-1" : { "credentialScope" : { "region" : "eu-south-1" }, + "deprecated" : true, "hostname" : "elasticfilesystem-fips.eu-south-1.amazonaws.com" }, "fips-eu-west-1" : { "credentialScope" : { "region" : "eu-west-1" }, + "deprecated" : true, "hostname" : "elasticfilesystem-fips.eu-west-1.amazonaws.com" }, "fips-eu-west-2" : { "credentialScope" : { "region" : "eu-west-2" }, + "deprecated" : true, "hostname" : "elasticfilesystem-fips.eu-west-2.amazonaws.com" }, "fips-eu-west-3" : { "credentialScope" : { "region" : "eu-west-3" }, + "deprecated" : true, "hostname" : "elasticfilesystem-fips.eu-west-3.amazonaws.com" }, "fips-me-south-1" : { "credentialScope" : { "region" : "me-south-1" }, + "deprecated" : true, "hostname" : "elasticfilesystem-fips.me-south-1.amazonaws.com" }, "fips-sa-east-1" : { "credentialScope" : { "region" : "sa-east-1" }, + "deprecated" : true, "hostname" : "elasticfilesystem-fips.sa-east-1.amazonaws.com" }, "fips-us-east-1" : { "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "elasticfilesystem-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "elasticfilesystem-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "elasticfilesystem-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "elasticfilesystem-fips.us-west-2.amazonaws.com" }, - "me-south-1" : { }, - "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "me-south-1" : { + "variants" : [ { + "hostname" : "elasticfilesystem-fips.me-south-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "sa-east-1" : { + "variants" : [ { + "hostname" : "elasticfilesystem-fips.sa-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-1" : { + "variants" : [ { + "hostname" : "elasticfilesystem-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "elasticfilesystem-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "elasticfilesystem-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "elasticfilesystem-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "elasticloadbalancing" : { @@ -2385,9 +4466,11 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-3" : { }, "ca-central-1" : { }, "eu-central-1" : { }, "eu-north-1" : { }, @@ -2399,32 +4482,56 @@ "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "elasticloadbalancing-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "elasticloadbalancing-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "elasticloadbalancing-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "elasticloadbalancing-fips.us-west-2.amazonaws.com" }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "elasticloadbalancing-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "elasticloadbalancing-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "elasticloadbalancing-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "elasticloadbalancing-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "elasticmapreduce" : { @@ -2437,10 +4544,17 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, - "ca-central-1" : { }, + "ap-southeast-3" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "elasticmapreduce-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "eu-central-1" : { "sslCommonName" : "{service}.{region}.{dnsSuffix}" }, @@ -2453,40 +4567,64 @@ "credentialScope" : { "region" : "ca-central-1" }, + "deprecated" : true, "hostname" : "elasticmapreduce-fips.ca-central-1.amazonaws.com" }, "fips-us-east-1" : { "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "elasticmapreduce-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "elasticmapreduce-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "elasticmapreduce-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "elasticmapreduce-fips.us-west-2.amazonaws.com" }, "me-south-1" : { }, "sa-east-1" : { }, "us-east-1" : { - "sslCommonName" : "{service}.{region}.{dnsSuffix}" + "sslCommonName" : "{service}.{region}.{dnsSuffix}", + "variants" : [ { + "hostname" : "elasticmapreduce-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-2" : { + "variants" : [ { + "hostname" : "elasticmapreduce-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "elasticmapreduce-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "elasticmapreduce-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "elastictranscoder" : { @@ -2511,6 +4649,86 @@ "us-west-2" : { } } }, + "emr-containers" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "emr-containers-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "fips-ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "deprecated" : true, + "hostname" : "emr-containers-fips.ca-central-1.amazonaws.com" + }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "emr-containers-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "hostname" : "emr-containers-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "deprecated" : true, + "hostname" : "emr-containers-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "hostname" : "emr-containers-fips.us-west-2.amazonaws.com" + }, + "sa-east-1" : { }, + "us-east-1" : { + "variants" : [ { + "hostname" : "emr-containers-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "emr-containers-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "emr-containers-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "emr-containers-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, "entitlement.marketplace" : { "defaults" : { "credentialScope" : { @@ -2527,9 +4745,11 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-3" : { }, "ca-central-1" : { }, "eu-central-1" : { }, "eu-north-1" : { }, @@ -2541,14 +4761,63 @@ "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "es-fips.us-west-1.amazonaws.com" }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "es-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-1-fips" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "es-fips.us-east-1.amazonaws.com" + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "es-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2-fips" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "hostname" : "es-fips.us-east-2.amazonaws.com" + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "es-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1-fips" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "deprecated" : true, + "hostname" : "es-fips.us-west-1.amazonaws.com" + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "es-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2-fips" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "hostname" : "es-fips.us-west-2.amazonaws.com" + } } }, "events" : { @@ -2557,9 +4826,11 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-3" : { }, "ca-central-1" : { }, "eu-central-1" : { }, "eu-north-1" : { }, @@ -2571,31 +4842,104 @@ "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "events-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "events-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "events-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "events-fips.us-west-2.amazonaws.com" }, "me-south-1" : { }, "sa-east-1" : { }, + "us-east-1" : { + "variants" : [ { + "hostname" : "events-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "events-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "events-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "events-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, + "evidently" : { + "endpoints" : { + "ap-northeast-1" : { + "hostname" : "evidently.ap-northeast-1.amazonaws.com" + }, + "ap-southeast-1" : { + "hostname" : "evidently.ap-southeast-1.amazonaws.com" + }, + "ap-southeast-2" : { + "hostname" : "evidently.ap-southeast-2.amazonaws.com" + }, + "eu-central-1" : { + "hostname" : "evidently.eu-central-1.amazonaws.com" + }, + "eu-north-1" : { + "hostname" : "evidently.eu-north-1.amazonaws.com" + }, + "eu-west-1" : { + "hostname" : "evidently.eu-west-1.amazonaws.com" + }, + "us-east-1" : { + "hostname" : "evidently.us-east-1.amazonaws.com" + }, + "us-east-2" : { + "hostname" : "evidently.us-east-2.amazonaws.com" + }, + "us-west-2" : { + "hostname" : "evidently.us-west-2.amazonaws.com" + } + } + }, + "finspace" : { + "endpoints" : { + "ca-central-1" : { }, + "eu-west-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-2" : { } + } + }, + "finspace-api" : { + "endpoints" : { + "ca-central-1" : { }, + "eu-west-1" : { }, "us-east-1" : { }, "us-east-2" : { }, - "us-west-1" : { }, "us-west-2" : { } } }, @@ -2605,6 +4949,7 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, @@ -2619,32 +4964,56 @@ "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "firehose-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "firehose-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "firehose-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "firehose-fips.us-west-2.amazonaws.com" }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "firehose-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "firehose-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "firehose-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "firehose-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "fms" : { @@ -2652,116 +5021,255 @@ "protocols" : [ "https" ] }, "endpoints" : { - "af-south-1" : { }, - "ap-east-1" : { }, - "ap-northeast-1" : { }, - "ap-northeast-2" : { }, - "ap-south-1" : { }, - "ap-southeast-1" : { }, - "ap-southeast-2" : { }, - "ca-central-1" : { }, - "eu-central-1" : { }, + "af-south-1" : { + "variants" : [ { + "hostname" : "fms-fips.af-south-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "ap-east-1" : { + "variants" : [ { + "hostname" : "fms-fips.ap-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "ap-northeast-1" : { + "variants" : [ { + "hostname" : "fms-fips.ap-northeast-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "ap-northeast-2" : { + "variants" : [ { + "hostname" : "fms-fips.ap-northeast-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "ap-northeast-3" : { }, + "ap-south-1" : { + "variants" : [ { + "hostname" : "fms-fips.ap-south-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "ap-southeast-1" : { + "variants" : [ { + "hostname" : "fms-fips.ap-southeast-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "ap-southeast-2" : { + "variants" : [ { + "hostname" : "fms-fips.ap-southeast-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "fms-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "eu-central-1" : { + "variants" : [ { + "hostname" : "fms-fips.eu-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "eu-north-1" : { }, - "eu-south-1" : { }, - "eu-west-1" : { }, - "eu-west-2" : { }, - "eu-west-3" : { }, + "eu-south-1" : { + "variants" : [ { + "hostname" : "fms-fips.eu-south-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "eu-west-1" : { + "variants" : [ { + "hostname" : "fms-fips.eu-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "eu-west-2" : { + "variants" : [ { + "hostname" : "fms-fips.eu-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "eu-west-3" : { + "variants" : [ { + "hostname" : "fms-fips.eu-west-3.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "fips-af-south-1" : { + "credentialScope" : { + "region" : "af-south-1" + }, + "deprecated" : true, + "hostname" : "fms-fips.af-south-1.amazonaws.com" + }, + "fips-ap-east-1" : { + "credentialScope" : { + "region" : "ap-east-1" + }, + "deprecated" : true, + "hostname" : "fms-fips.ap-east-1.amazonaws.com" + }, "fips-ap-northeast-1" : { "credentialScope" : { "region" : "ap-northeast-1" }, + "deprecated" : true, "hostname" : "fms-fips.ap-northeast-1.amazonaws.com" }, "fips-ap-northeast-2" : { "credentialScope" : { "region" : "ap-northeast-2" }, + "deprecated" : true, "hostname" : "fms-fips.ap-northeast-2.amazonaws.com" }, "fips-ap-south-1" : { "credentialScope" : { "region" : "ap-south-1" }, + "deprecated" : true, "hostname" : "fms-fips.ap-south-1.amazonaws.com" }, "fips-ap-southeast-1" : { "credentialScope" : { "region" : "ap-southeast-1" }, + "deprecated" : true, "hostname" : "fms-fips.ap-southeast-1.amazonaws.com" }, "fips-ap-southeast-2" : { "credentialScope" : { "region" : "ap-southeast-2" }, + "deprecated" : true, "hostname" : "fms-fips.ap-southeast-2.amazonaws.com" }, "fips-ca-central-1" : { "credentialScope" : { "region" : "ca-central-1" }, + "deprecated" : true, "hostname" : "fms-fips.ca-central-1.amazonaws.com" }, "fips-eu-central-1" : { "credentialScope" : { "region" : "eu-central-1" }, + "deprecated" : true, "hostname" : "fms-fips.eu-central-1.amazonaws.com" }, + "fips-eu-south-1" : { + "credentialScope" : { + "region" : "eu-south-1" + }, + "deprecated" : true, + "hostname" : "fms-fips.eu-south-1.amazonaws.com" + }, "fips-eu-west-1" : { "credentialScope" : { "region" : "eu-west-1" }, + "deprecated" : true, "hostname" : "fms-fips.eu-west-1.amazonaws.com" }, "fips-eu-west-2" : { "credentialScope" : { "region" : "eu-west-2" }, + "deprecated" : true, "hostname" : "fms-fips.eu-west-2.amazonaws.com" }, "fips-eu-west-3" : { "credentialScope" : { "region" : "eu-west-3" }, + "deprecated" : true, "hostname" : "fms-fips.eu-west-3.amazonaws.com" }, + "fips-me-south-1" : { + "credentialScope" : { + "region" : "me-south-1" + }, + "deprecated" : true, + "hostname" : "fms-fips.me-south-1.amazonaws.com" + }, "fips-sa-east-1" : { "credentialScope" : { "region" : "sa-east-1" }, + "deprecated" : true, "hostname" : "fms-fips.sa-east-1.amazonaws.com" }, "fips-us-east-1" : { "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "fms-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "fms-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "fms-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "fms-fips.us-west-2.amazonaws.com" }, - "me-south-1" : { }, - "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "me-south-1" : { + "variants" : [ { + "hostname" : "fms-fips.me-south-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "sa-east-1" : { + "variants" : [ { + "hostname" : "fms-fips.sa-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-1" : { + "variants" : [ { + "hostname" : "fms-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "fms-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "fms-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "fms-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "forecast" : { @@ -2773,9 +5281,45 @@ "ap-southeast-2" : { }, "eu-central-1" : { }, "eu-west-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-2" : { } + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "forecast-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "hostname" : "forecast-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "hostname" : "forecast-fips.us-west-2.amazonaws.com" + }, + "us-east-1" : { + "variants" : [ { + "hostname" : "forecast-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "forecast-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "forecast-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "forecastquery" : { @@ -2787,6 +5331,52 @@ "ap-southeast-2" : { }, "eu-central-1" : { }, "eu-west-1" : { }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "forecastquery-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "hostname" : "forecastquery-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "hostname" : "forecastquery-fips.us-west-2.amazonaws.com" + }, + "us-east-1" : { + "variants" : [ { + "hostname" : "forecastquery-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "forecastquery-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "forecastquery-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, + "frauddetector" : { + "endpoints" : { + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "eu-west-1" : { }, "us-east-1" : { }, "us-east-2" : { }, "us-west-2" : { } @@ -2794,36 +5384,192 @@ }, "fsx" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, - "ca-central-1" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "fsx-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "eu-central-1" : { }, "eu-north-1" : { }, + "eu-south-1" : { }, "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "fips-ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "deprecated" : true, + "hostname" : "fsx-fips.ca-central-1.amazonaws.com" + }, + "fips-prod-ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "deprecated" : true, + "hostname" : "fsx-fips.ca-central-1.amazonaws.com" + }, + "fips-prod-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "fsx-fips.us-east-1.amazonaws.com" + }, + "fips-prod-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "hostname" : "fsx-fips.us-east-2.amazonaws.com" + }, + "fips-prod-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "deprecated" : true, + "hostname" : "fsx-fips.us-west-1.amazonaws.com" + }, + "fips-prod-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "hostname" : "fsx-fips.us-west-2.amazonaws.com" + }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "fsx-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "hostname" : "fsx-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "deprecated" : true, + "hostname" : "fsx-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "hostname" : "fsx-fips.us-west-2.amazonaws.com" + }, + "me-south-1" : { }, + "prod-ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "deprecated" : true, + "variants" : [ { + "hostname" : "fsx-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "prod-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "variants" : [ { + "hostname" : "fsx-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "prod-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "variants" : [ { + "hostname" : "fsx-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "prod-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "deprecated" : true, + "variants" : [ { + "hostname" : "fsx-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "prod-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "variants" : [ { + "hostname" : "fsx-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "fsx-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "fsx-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "fsx-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "fsx-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "gamelift" : { "endpoints" : { + "af-south-1" : { }, + "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, "ca-central-1" : { }, "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-south-1" : { }, "eu-west-1" : { }, "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, "sa-east-1" : { }, "us-east-1" : { }, "us-east-2" : { }, @@ -2840,10 +5586,17 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, - "ca-central-1" : { }, + "ap-southeast-3" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "glacier-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "eu-central-1" : { }, "eu-north-1" : { }, "eu-south-1" : { }, @@ -2854,38 +5607,63 @@ "credentialScope" : { "region" : "ca-central-1" }, + "deprecated" : true, "hostname" : "glacier-fips.ca-central-1.amazonaws.com" }, "fips-us-east-1" : { "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "glacier-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "glacier-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "glacier-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "glacier-fips.us-west-2.amazonaws.com" }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "glacier-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "glacier-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "glacier-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "glacier-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "glue" : { @@ -2894,6 +5672,7 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, @@ -2908,32 +5687,120 @@ "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "glue-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "glue-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "glue-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "glue-fips.us-west-2.amazonaws.com" }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "glue-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "glue-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "glue-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "glue-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, + "grafana" : { + "endpoints" : { + "ap-northeast-1" : { + "credentialScope" : { + "region" : "ap-northeast-1" + }, + "hostname" : "grafana.ap-northeast-1.amazonaws.com" + }, + "ap-northeast-2" : { + "credentialScope" : { + "region" : "ap-northeast-2" + }, + "hostname" : "grafana.ap-northeast-2.amazonaws.com" + }, + "ap-southeast-1" : { + "credentialScope" : { + "region" : "ap-southeast-1" + }, + "hostname" : "grafana.ap-southeast-1.amazonaws.com" + }, + "ap-southeast-2" : { + "credentialScope" : { + "region" : "ap-southeast-2" + }, + "hostname" : "grafana.ap-southeast-2.amazonaws.com" + }, + "eu-central-1" : { + "credentialScope" : { + "region" : "eu-central-1" + }, + "hostname" : "grafana.eu-central-1.amazonaws.com" + }, + "eu-west-1" : { + "credentialScope" : { + "region" : "eu-west-1" + }, + "hostname" : "grafana.eu-west-1.amazonaws.com" + }, + "eu-west-2" : { + "credentialScope" : { + "region" : "eu-west-2" + }, + "hostname" : "grafana.eu-west-2.amazonaws.com" + }, + "us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "grafana.us-east-1.amazonaws.com" + }, + "us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "grafana.us-east-2.amazonaws.com" + }, + "us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "grafana.us-west-2.amazonaws.com" + } } }, "greengrass" : { @@ -2946,6 +5813,7 @@ "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ca-central-1" : { }, "eu-central-1" : { }, "eu-west-1" : { }, "eu-west-2" : { }, @@ -2958,24 +5826,52 @@ "groundstation" : { "endpoints" : { "af-south-1" : { }, + "ap-northeast-2" : { }, "ap-southeast-2" : { }, + "eu-central-1" : { }, "eu-north-1" : { }, "eu-west-1" : { }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "groundstation-fips.us-east-1.amazonaws.com" + }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "groundstation-fips.us-east-2.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "groundstation-fips.us-west-2.amazonaws.com" }, "me-south-1" : { }, - "us-east-2" : { }, - "us-west-2" : { } + "sa-east-1" : { }, + "us-east-1" : { + "variants" : [ { + "hostname" : "groundstation-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "groundstation-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "groundstation-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "guardduty" : { @@ -2987,9 +5883,11 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-3" : { }, "ca-central-1" : { }, "eu-central-1" : { }, "eu-north-1" : { }, @@ -2999,32 +5897,56 @@ "eu-west-3" : { }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, + "us-east-1" : { + "variants" : [ { + "hostname" : "guardduty-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-east-1-fips" : { "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "guardduty-fips.us-east-1.amazonaws.com" }, - "us-east-2" : { }, + "us-east-2" : { + "variants" : [ { + "hostname" : "guardduty-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-east-2-fips" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "guardduty-fips.us-east-2.amazonaws.com" }, - "us-west-1" : { }, + "us-west-1" : { + "variants" : [ { + "hostname" : "guardduty-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-west-1-fips" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "guardduty-fips.us-west-1.amazonaws.com" }, - "us-west-2" : { }, + "us-west-2" : { + "variants" : [ { + "hostname" : "guardduty-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-west-2-fips" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "guardduty-fips.us-west-2.amazonaws.com" } }, @@ -3036,11 +5958,32 @@ "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "health-fips.us-east-2.amazonaws.com" + }, + "us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "variants" : [ { + "hostname" : "health-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] } } }, - "honeycode" : { + "healthlake" : { + "defaults" : { + "protocols" : [ "https" ] + }, + "endpoints" : { + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-2" : { } + } + }, + "honeycode" : { "endpoints" : { "us-west-2" : { } } @@ -3051,18 +5994,57 @@ "credentialScope" : { "region" : "us-east-1" }, - "hostname" : "iam.amazonaws.com" + "hostname" : "iam.amazonaws.com", + "variants" : [ { + "hostname" : "iam-fips.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "aws-global-fips" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "iam-fips.amazonaws.com" + }, + "iam" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "variants" : [ { + "hostname" : "iam-fips.amazonaws.com", + "tags" : [ "fips" ] + } ] }, "iam-fips" : { "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "iam-fips.amazonaws.com" } }, "isRegionalized" : false, "partitionEndpoint" : "aws-global" }, + "identity-chime" : { + "endpoints" : { + "us-east-1" : { + "variants" : [ { + "hostname" : "identity-chime-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-1-fips" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "identity-chime-fips.us-east-1.amazonaws.com" + } + } + }, "identitystore" : { "endpoints" : { "ap-northeast-1" : { }, @@ -3108,26 +6090,73 @@ "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "inspector-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "inspector-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "inspector-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "inspector-fips.us-west-2.amazonaws.com" }, + "us-east-1" : { + "variants" : [ { + "hostname" : "inspector-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "inspector-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "inspector-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "inspector-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, + "inspector2" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-south-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, "us-east-1" : { }, "us-east-2" : { }, "us-west-1" : { }, @@ -3147,23 +6176,84 @@ "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, - "ca-central-1" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "iot-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "eu-central-1" : { }, "eu-north-1" : { }, "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "fips-ca-central-1" : { + "credentialScope" : { + "service" : "execute-api" + }, + "deprecated" : true, + "hostname" : "iot-fips.ca-central-1.amazonaws.com" + }, + "fips-us-east-1" : { + "credentialScope" : { + "service" : "execute-api" + }, + "deprecated" : true, + "hostname" : "iot-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "service" : "execute-api" + }, + "deprecated" : true, + "hostname" : "iot-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "service" : "execute-api" + }, + "deprecated" : true, + "hostname" : "iot-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "service" : "execute-api" + }, + "deprecated" : true, + "hostname" : "iot-fips.us-west-2.amazonaws.com" + }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "iot-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "iot-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "iot-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "iot-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "iotanalytics" : { "endpoints" : { "ap-northeast-1" : { }, + "ap-south-1" : { }, "ap-southeast-2" : { }, "eu-central-1" : { }, "eu-west-1" : { }, @@ -3176,6 +6266,7 @@ "endpoints" : { "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, "eu-central-1" : { }, @@ -3200,6 +6291,12 @@ }, "hostname" : "data.iotevents.ap-northeast-2.amazonaws.com" }, + "ap-south-1" : { + "credentialScope" : { + "region" : "ap-south-1" + }, + "hostname" : "data.iotevents.ap-south-1.amazonaws.com" + }, "ap-southeast-1" : { "credentialScope" : { "region" : "ap-southeast-1" @@ -3251,6 +6348,12 @@ } }, "iotsecuredtunneling" : { + "defaults" : { + "variants" : [ { + "hostname" : "api.tunneling.iot-fips.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] + }, "endpoints" : { "ap-east-1" : { }, "ap-northeast-1" : { }, @@ -3258,17 +6361,90 @@ "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, - "ca-central-1" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "api.tunneling.iot-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "eu-central-1" : { }, "eu-north-1" : { }, "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "fips-ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "deprecated" : true, + "hostname" : "api.tunneling.iot-fips.ca-central-1.amazonaws.com" + }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "api.tunneling.iot-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "hostname" : "api.tunneling.iot-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "deprecated" : true, + "hostname" : "api.tunneling.iot-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "hostname" : "api.tunneling.iot-fips.us-west-2.amazonaws.com" + }, "me-south-1" : { }, "sa-east-1" : { }, + "us-east-1" : { + "variants" : [ { + "hostname" : "api.tunneling.iot-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "api.tunneling.iot-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "api.tunneling.iot-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "api.tunneling.iot-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, + "iotsitewise" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, "us-west-2" : { } } }, @@ -3287,11 +6463,58 @@ "us-west-2" : { } } }, + "iotwireless" : { + "endpoints" : { + "ap-northeast-1" : { + "credentialScope" : { + "region" : "ap-northeast-1" + }, + "hostname" : "api.iotwireless.ap-northeast-1.amazonaws.com" + }, + "ap-southeast-2" : { + "credentialScope" : { + "region" : "ap-southeast-2" + }, + "hostname" : "api.iotwireless.ap-southeast-2.amazonaws.com" + }, + "eu-west-1" : { + "credentialScope" : { + "region" : "eu-west-1" + }, + "hostname" : "api.iotwireless.eu-west-1.amazonaws.com" + }, + "us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "api.iotwireless.us-east-1.amazonaws.com" + }, + "us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "api.iotwireless.us-west-2.amazonaws.com" + } + } + }, + "ivs" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "us-east-1" : { }, + "us-west-2" : { } + } + }, "kafka" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, @@ -3310,15 +6533,84 @@ "us-west-2" : { } } }, + "kafkaconnect" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "kendra" : { + "endpoints" : { + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-west-1" : { }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "kendra-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "hostname" : "kendra-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "hostname" : "kendra-fips.us-west-2.amazonaws.com" + }, + "us-east-1" : { + "variants" : [ { + "hostname" : "kendra-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "kendra-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "kendra-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, "kinesis" : { "endpoints" : { "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-3" : { }, "ca-central-1" : { }, "eu-central-1" : { }, "eu-north-1" : { }, @@ -3330,39 +6622,65 @@ "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "kinesis-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "kinesis-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "kinesis-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "kinesis-fips.us-west-2.amazonaws.com" }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "kinesis-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "kinesis-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "kinesis-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "kinesis-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "kinesisanalytics" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, @@ -3402,32 +6720,301 @@ }, "kms" : { "endpoints" : { - "af-south-1" : { }, - "ap-east-1" : { }, - "ap-northeast-1" : { }, - "ap-northeast-2" : { }, - "ap-south-1" : { }, - "ap-southeast-1" : { }, - "ap-southeast-2" : { }, - "ca-central-1" : { }, - "eu-central-1" : { }, - "eu-north-1" : { }, - "eu-south-1" : { }, - "eu-west-1" : { }, - "eu-west-2" : { }, - "eu-west-3" : { }, - "me-south-1" : { }, - "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "af-south-1" : { + "variants" : [ { + "hostname" : "kms-fips.af-south-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "af-south-1-fips" : { + "credentialScope" : { + "region" : "af-south-1" + }, + "deprecated" : true, + "hostname" : "kms-fips.af-south-1.amazonaws.com" + }, + "ap-east-1" : { + "variants" : [ { + "hostname" : "kms-fips.ap-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "ap-east-1-fips" : { + "credentialScope" : { + "region" : "ap-east-1" + }, + "deprecated" : true, + "hostname" : "kms-fips.ap-east-1.amazonaws.com" + }, + "ap-northeast-1" : { + "variants" : [ { + "hostname" : "kms-fips.ap-northeast-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "ap-northeast-1-fips" : { + "credentialScope" : { + "region" : "ap-northeast-1" + }, + "deprecated" : true, + "hostname" : "kms-fips.ap-northeast-1.amazonaws.com" + }, + "ap-northeast-2" : { + "variants" : [ { + "hostname" : "kms-fips.ap-northeast-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "ap-northeast-2-fips" : { + "credentialScope" : { + "region" : "ap-northeast-2" + }, + "deprecated" : true, + "hostname" : "kms-fips.ap-northeast-2.amazonaws.com" + }, + "ap-northeast-3" : { + "variants" : [ { + "hostname" : "kms-fips.ap-northeast-3.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "ap-northeast-3-fips" : { + "credentialScope" : { + "region" : "ap-northeast-3" + }, + "deprecated" : true, + "hostname" : "kms-fips.ap-northeast-3.amazonaws.com" + }, + "ap-south-1" : { + "variants" : [ { + "hostname" : "kms-fips.ap-south-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "ap-south-1-fips" : { + "credentialScope" : { + "region" : "ap-south-1" + }, + "deprecated" : true, + "hostname" : "kms-fips.ap-south-1.amazonaws.com" + }, + "ap-southeast-1" : { + "variants" : [ { + "hostname" : "kms-fips.ap-southeast-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "ap-southeast-1-fips" : { + "credentialScope" : { + "region" : "ap-southeast-1" + }, + "deprecated" : true, + "hostname" : "kms-fips.ap-southeast-1.amazonaws.com" + }, + "ap-southeast-2" : { + "variants" : [ { + "hostname" : "kms-fips.ap-southeast-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "ap-southeast-2-fips" : { + "credentialScope" : { + "region" : "ap-southeast-2" + }, + "deprecated" : true, + "hostname" : "kms-fips.ap-southeast-2.amazonaws.com" + }, + "ap-southeast-3" : { + "variants" : [ { + "hostname" : "kms-fips.ap-southeast-3.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "ap-southeast-3-fips" : { + "credentialScope" : { + "region" : "ap-southeast-3" + }, + "deprecated" : true, + "hostname" : "kms-fips.ap-southeast-3.amazonaws.com" + }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "kms-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "ca-central-1-fips" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "deprecated" : true, + "hostname" : "kms-fips.ca-central-1.amazonaws.com" + }, + "eu-central-1" : { + "variants" : [ { + "hostname" : "kms-fips.eu-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "eu-central-1-fips" : { + "credentialScope" : { + "region" : "eu-central-1" + }, + "deprecated" : true, + "hostname" : "kms-fips.eu-central-1.amazonaws.com" + }, + "eu-north-1" : { + "variants" : [ { + "hostname" : "kms-fips.eu-north-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "eu-north-1-fips" : { + "credentialScope" : { + "region" : "eu-north-1" + }, + "deprecated" : true, + "hostname" : "kms-fips.eu-north-1.amazonaws.com" + }, + "eu-south-1" : { + "variants" : [ { + "hostname" : "kms-fips.eu-south-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "eu-south-1-fips" : { + "credentialScope" : { + "region" : "eu-south-1" + }, + "deprecated" : true, + "hostname" : "kms-fips.eu-south-1.amazonaws.com" + }, + "eu-west-1" : { + "variants" : [ { + "hostname" : "kms-fips.eu-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "eu-west-1-fips" : { + "credentialScope" : { + "region" : "eu-west-1" + }, + "deprecated" : true, + "hostname" : "kms-fips.eu-west-1.amazonaws.com" + }, + "eu-west-2" : { + "variants" : [ { + "hostname" : "kms-fips.eu-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "eu-west-2-fips" : { + "credentialScope" : { + "region" : "eu-west-2" + }, + "deprecated" : true, + "hostname" : "kms-fips.eu-west-2.amazonaws.com" + }, + "eu-west-3" : { + "variants" : [ { + "hostname" : "kms-fips.eu-west-3.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "eu-west-3-fips" : { + "credentialScope" : { + "region" : "eu-west-3" + }, + "deprecated" : true, + "hostname" : "kms-fips.eu-west-3.amazonaws.com" + }, + "me-south-1" : { + "variants" : [ { + "hostname" : "kms-fips.me-south-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "me-south-1-fips" : { + "credentialScope" : { + "region" : "me-south-1" + }, + "deprecated" : true, + "hostname" : "kms-fips.me-south-1.amazonaws.com" + }, + "sa-east-1" : { + "variants" : [ { + "hostname" : "kms-fips.sa-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "sa-east-1-fips" : { + "credentialScope" : { + "region" : "sa-east-1" + }, + "deprecated" : true, + "hostname" : "kms-fips.sa-east-1.amazonaws.com" + }, + "us-east-1" : { + "variants" : [ { + "hostname" : "kms-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-1-fips" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "kms-fips.us-east-1.amazonaws.com" + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "kms-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2-fips" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "hostname" : "kms-fips.us-east-2.amazonaws.com" + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "kms-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1-fips" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "deprecated" : true, + "hostname" : "kms-fips.us-west-1.amazonaws.com" + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "kms-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2-fips" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "hostname" : "kms-fips.us-west-2.amazonaws.com" + } } }, "lakeformation" : { "endpoints" : { + "af-south-1" : { }, + "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, @@ -3442,79 +7029,232 @@ "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "lakeformation-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "lakeformation-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "lakeformation-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "lakeformation-fips.us-west-2.amazonaws.com" }, + "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "lakeformation-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "lakeformation-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "lakeformation-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "lakeformation-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "lambda" : { "endpoints" : { - "af-south-1" : { }, - "ap-east-1" : { }, - "ap-northeast-1" : { }, - "ap-northeast-2" : { }, - "ap-south-1" : { }, - "ap-southeast-1" : { }, - "ap-southeast-2" : { }, - "ca-central-1" : { }, - "eu-central-1" : { }, - "eu-north-1" : { }, - "eu-south-1" : { }, - "eu-west-1" : { }, - "eu-west-2" : { }, - "eu-west-3" : { }, + "af-south-1" : { + "variants" : [ { + "hostname" : "lambda.af-south-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-east-1" : { + "variants" : [ { + "hostname" : "lambda.ap-east-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-northeast-1" : { + "variants" : [ { + "hostname" : "lambda.ap-northeast-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-northeast-2" : { + "variants" : [ { + "hostname" : "lambda.ap-northeast-2.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-northeast-3" : { + "variants" : [ { + "hostname" : "lambda.ap-northeast-3.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-south-1" : { + "variants" : [ { + "hostname" : "lambda.ap-south-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-southeast-1" : { + "variants" : [ { + "hostname" : "lambda.ap-southeast-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-southeast-2" : { + "variants" : [ { + "hostname" : "lambda.ap-southeast-2.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-southeast-3" : { + "variants" : [ { + "hostname" : "lambda.ap-southeast-3.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "lambda.ca-central-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "eu-central-1" : { + "variants" : [ { + "hostname" : "lambda.eu-central-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "eu-north-1" : { + "variants" : [ { + "hostname" : "lambda.eu-north-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "eu-south-1" : { + "variants" : [ { + "hostname" : "lambda.eu-south-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "eu-west-1" : { + "variants" : [ { + "hostname" : "lambda.eu-west-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "eu-west-2" : { + "variants" : [ { + "hostname" : "lambda.eu-west-2.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "eu-west-3" : { + "variants" : [ { + "hostname" : "lambda.eu-west-3.api.aws", + "tags" : [ "dualstack" ] + } ] + }, "fips-us-east-1" : { "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "lambda-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "lambda-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "lambda-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "lambda-fips.us-west-2.amazonaws.com" }, - "me-south-1" : { }, - "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "me-south-1" : { + "variants" : [ { + "hostname" : "lambda.me-south-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "sa-east-1" : { + "variants" : [ { + "hostname" : "lambda.sa-east-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "us-east-1" : { + "variants" : [ { + "hostname" : "lambda-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + }, { + "hostname" : "lambda.us-east-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "lambda-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + }, { + "hostname" : "lambda.us-east-2.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "lambda-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + }, { + "hostname" : "lambda.us-west-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "lambda-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + }, { + "hostname" : "lambda.us-west-2.api.aws", + "tags" : [ "dualstack" ] + } ] + } } }, "license-manager" : { @@ -3523,6 +7263,7 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, @@ -3537,32 +7278,56 @@ "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "license-manager-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "license-manager-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "license-manager-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "license-manager-fips.us-west-2.amazonaws.com" }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "license-manager-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "license-manager-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "license-manager-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "license-manager-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "lightsail" : { @@ -3574,6 +7339,7 @@ "ap-southeast-2" : { }, "ca-central-1" : { }, "eu-central-1" : { }, + "eu-north-1" : { }, "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, @@ -3588,9 +7354,11 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-3" : { }, "ca-central-1" : { }, "eu-central-1" : { }, "eu-north-1" : { }, @@ -3602,31 +7370,86 @@ "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "logs-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "logs-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "logs-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "logs-fips.us-west-2.amazonaws.com" }, "me-south-1" : { }, "sa-east-1" : { }, + "us-east-1" : { + "variants" : [ { + "hostname" : "logs-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "logs-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "logs-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "logs-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, + "lookoutequipment" : { + "endpoints" : { + "ap-northeast-2" : { }, + "eu-west-1" : { }, + "us-east-1" : { } + } + }, + "lookoutmetrics" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-2" : { } + } + }, + "lookoutvision" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, "us-east-1" : { }, "us-east-2" : { }, - "us-west-1" : { }, "us-west-2" : { } } }, @@ -3642,29 +7465,44 @@ "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "macie-fips.us-east-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "macie-fips.us-west-2.amazonaws.com" }, - "us-east-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "macie-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "macie-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "macie2" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, "ca-central-1" : { }, "eu-central-1" : { }, "eu-north-1" : { }, + "eu-south-1" : { }, "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, @@ -3672,31 +7510,56 @@ "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "macie2-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "macie2-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "macie2-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "macie2-fips.us-west-2.amazonaws.com" }, + "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "macie2-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "macie2-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "macie2-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "macie2-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "managedblockchain" : { @@ -3741,7 +7604,12 @@ "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, - "ca-central-1" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "mediaconvert-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "eu-central-1" : { }, "eu-north-1" : { }, "eu-west-1" : { }, @@ -3751,37 +7619,62 @@ "credentialScope" : { "region" : "ca-central-1" }, + "deprecated" : true, "hostname" : "mediaconvert-fips.ca-central-1.amazonaws.com" }, "fips-us-east-1" : { "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "mediaconvert-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "mediaconvert-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "mediaconvert-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "mediaconvert-fips.us-west-2.amazonaws.com" }, "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "mediaconvert-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "mediaconvert-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "mediaconvert-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "mediaconvert-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "medialive" : { @@ -3800,27 +7693,64 @@ "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "medialive-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "medialive-fips.us-east-2.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "medialive-fips.us-west-2.amazonaws.com" }, "sa-east-1" : { }, + "us-east-1" : { + "variants" : [ { + "hostname" : "medialive-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "medialive-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "medialive-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, + "mediapackage" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "sa-east-1" : { }, "us-east-1" : { }, "us-east-2" : { }, + "us-west-1" : { }, "us-west-2" : { } } }, - "mediapackage" : { + "mediapackage-vod" : { "endpoints" : { "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -3834,6 +7764,7 @@ "eu-west-3" : { }, "sa-east-1" : { }, "us-east-1" : { }, + "us-east-2" : { }, "us-west-1" : { }, "us-west-2" : { } } @@ -3851,6 +7782,55 @@ "us-west-2" : { } } }, + "meetings-chime" : { + "endpoints" : { + "ap-southeast-1" : { }, + "eu-central-1" : { }, + "us-east-1" : { + "variants" : [ { + "hostname" : "meetings-chime-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-1-fips" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "meetings-chime-fips.us-east-1.amazonaws.com" + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "meetings-chime-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2-fips" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "hostname" : "meetings-chime-fips.us-west-2.amazonaws.com" + } + } + }, + "messaging-chime" : { + "endpoints" : { + "us-east-1" : { + "variants" : [ { + "hostname" : "messaging-chime-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-1-fips" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "messaging-chime-fips.us-east-1.amazonaws.com" + } + } + }, "metering.marketplace" : { "defaults" : { "credentialScope" : { @@ -3862,9 +7842,11 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-3" : { }, "ca-central-1" : { }, "eu-central-1" : { }, "eu-north-1" : { }, @@ -3891,16 +7873,71 @@ "us-west-2" : { } } }, + "mgn" : { + "endpoints" : { + "af-south-1" : { }, + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-northeast-3" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-south-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "migrationhub-strategy" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-southeast-2" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "us-east-1" : { }, + "us-west-2" : { } + } + }, "mobileanalytics" : { "endpoints" : { "us-east-1" : { } } }, + "models-v2-lex" : { + "endpoints" : { + "af-south-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "us-east-1" : { }, + "us-west-2" : { } + } + }, "models.lex" : { "defaults" : { "credentialScope" : { "service" : "lex" - } + }, + "variants" : [ { + "hostname" : "models-fips.lex.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] }, "endpoints" : { "ap-northeast-1" : { }, @@ -3909,8 +7946,32 @@ "eu-central-1" : { }, "eu-west-1" : { }, "eu-west-2" : { }, - "us-east-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "models-fips.lex.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-1-fips" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "models-fips.lex.us-east-1.amazonaws.com" + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "models-fips.lex.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2-fips" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "hostname" : "models-fips.lex.us-west-2.amazonaws.com" + } } }, "monitoring" : { @@ -3922,9 +7983,11 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-3" : { }, "ca-central-1" : { }, "eu-central-1" : { }, "eu-north-1" : { }, @@ -3936,42 +7999,69 @@ "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "monitoring-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "monitoring-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "monitoring-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "monitoring-fips.us-west-2.amazonaws.com" }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "monitoring-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "monitoring-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "monitoring-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "monitoring-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "mq" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-3" : { }, "ca-central-1" : { }, "eu-central-1" : { }, "eu-north-1" : { }, @@ -3983,32 +8073,56 @@ "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "mq-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "mq-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "mq-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "mq-fips.us-west-2.amazonaws.com" }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "mq-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "mq-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "mq-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "mq-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "mturk-requester" : { @@ -4132,6 +8246,112 @@ } } }, + "network-firewall" : { + "endpoints" : { + "af-south-1" : { }, + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-northeast-3" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "network-firewall-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-south-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "fips-ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "deprecated" : true, + "hostname" : "network-firewall-fips.ca-central-1.amazonaws.com" + }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "network-firewall-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "hostname" : "network-firewall-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "deprecated" : true, + "hostname" : "network-firewall-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "hostname" : "network-firewall-fips.us-west-2.amazonaws.com" + }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { + "variants" : [ { + "hostname" : "network-firewall-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "network-firewall-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "network-firewall-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "network-firewall-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, + "networkmanager" : { + "endpoints" : { + "aws-global" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "networkmanager.us-west-2.amazonaws.com" + } + }, + "isRegionalized" : false, + "partitionEndpoint" : "aws-global" + }, + "nimble" : { + "endpoints" : { + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-west-2" : { }, + "us-east-1" : { }, + "us-west-2" : { } + } + }, "oidc" : { "endpoints" : { "ap-northeast-1" : { @@ -4194,6 +8414,18 @@ }, "hostname" : "oidc.eu-west-2.amazonaws.com" }, + "eu-west-3" : { + "credentialScope" : { + "region" : "eu-west-3" + }, + "hostname" : "oidc.eu-west-3.amazonaws.com" + }, + "sa-east-1" : { + "credentialScope" : { + "region" : "sa-east-1" + }, + "hostname" : "oidc.sa-east-1.amazonaws.com" + }, "us-east-1" : { "credentialScope" : { "region" : "us-east-1" @@ -4252,12 +8484,17 @@ "credentialScope" : { "region" : "us-east-1" }, - "hostname" : "organizations.us-east-1.amazonaws.com" + "hostname" : "organizations.us-east-1.amazonaws.com", + "variants" : [ { + "hostname" : "organizations-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] }, "fips-aws-global" : { "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "organizations-fips.us-east-1.amazonaws.com" } }, @@ -4270,10 +8507,16 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, - "ca-central-1" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "outposts-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "eu-central-1" : { }, "eu-north-1" : { }, "eu-south-1" : { }, @@ -4284,34 +8527,99 @@ "credentialScope" : { "region" : "ca-central-1" }, + "deprecated" : true, "hostname" : "outposts-fips.ca-central-1.amazonaws.com" }, "fips-us-east-1" : { "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "outposts-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "outposts-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "outposts-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "outposts-fips.us-west-2.amazonaws.com" }, "me-south-1" : { }, "sa-east-1" : { }, + "us-east-1" : { + "variants" : [ { + "hostname" : "outposts-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "outposts-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "outposts-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "outposts-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, + "personalize" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-2" : { } + } + }, + "pi" : { + "endpoints" : { + "af-south-1" : { }, + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-northeast-3" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-south-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, "us-east-1" : { }, "us-east-2" : { }, "us-west-1" : { }, @@ -4338,30 +8646,41 @@ "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "pinpoint-fips.us-east-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "pinpoint-fips.us-west-2.amazonaws.com" }, "us-east-1" : { "credentialScope" : { "region" : "us-east-1" }, - "hostname" : "pinpoint.us-east-1.amazonaws.com" + "hostname" : "pinpoint.us-east-1.amazonaws.com", + "variants" : [ { + "hostname" : "pinpoint-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] }, "us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, - "hostname" : "pinpoint.us-west-2.amazonaws.com" + "hostname" : "pinpoint.us-west-2.amazonaws.com", + "variants" : [ { + "hostname" : "pinpoint-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] } } }, "polly" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -4378,36 +8697,78 @@ "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "polly-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "polly-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "polly-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "polly-fips.us-west-2.amazonaws.com" }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "polly-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "polly-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "polly-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "polly-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "portal.sso" : { "endpoints" : { + "ap-northeast-1" : { + "credentialScope" : { + "region" : "ap-northeast-1" + }, + "hostname" : "portal.sso.ap-northeast-1.amazonaws.com" + }, + "ap-northeast-2" : { + "credentialScope" : { + "region" : "ap-northeast-2" + }, + "hostname" : "portal.sso.ap-northeast-2.amazonaws.com" + }, + "ap-south-1" : { + "credentialScope" : { + "region" : "ap-south-1" + }, + "hostname" : "portal.sso.ap-south-1.amazonaws.com" + }, "ap-southeast-1" : { "credentialScope" : { "region" : "ap-southeast-1" @@ -4432,6 +8793,12 @@ }, "hostname" : "portal.sso.eu-central-1.amazonaws.com" }, + "eu-north-1" : { + "credentialScope" : { + "region" : "eu-north-1" + }, + "hostname" : "portal.sso.eu-north-1.amazonaws.com" + }, "eu-west-1" : { "credentialScope" : { "region" : "eu-west-1" @@ -4444,6 +8811,18 @@ }, "hostname" : "portal.sso.eu-west-2.amazonaws.com" }, + "eu-west-3" : { + "credentialScope" : { + "region" : "eu-west-3" + }, + "hostname" : "portal.sso.eu-west-3.amazonaws.com" + }, + "sa-east-1" : { + "credentialScope" : { + "region" : "sa-east-1" + }, + "hostname" : "portal.sso.sa-east-1.amazonaws.com" + }, "us-east-1" : { "credentialScope" : { "region" : "us-east-1" @@ -4464,6 +8843,18 @@ } } }, + "profile" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-west-2" : { }, + "us-east-1" : { }, + "us-west-2" : { } + } + }, "projects.iot1click" : { "endpoints" : { "ap-northeast-1" : { }, @@ -4481,8 +8872,64 @@ "ap-northeast-2" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "qldb-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "hostname" : "qldb-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "hostname" : "qldb-fips.us-west-2.amazonaws.com" + }, + "us-east-1" : { + "variants" : [ { + "hostname" : "qldb-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "qldb-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "qldb-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, + "quicksight" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "api" : { }, + "ca-central-1" : { }, "eu-central-1" : { }, "eu-west-1" : { }, + "eu-west-2" : { }, + "sa-east-1" : { }, "us-east-1" : { }, "us-east-2" : { }, "us-west-2" : { } @@ -4494,6 +8941,92 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "ram-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-south-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "fips-ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "deprecated" : true, + "hostname" : "ram-fips.ca-central-1.amazonaws.com" + }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "ram-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "hostname" : "ram-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "deprecated" : true, + "hostname" : "ram-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "hostname" : "ram-fips.us-west-2.amazonaws.com" + }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { + "variants" : [ { + "hostname" : "ram-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "ram-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "ram-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "ram-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, + "rbin" : { + "endpoints" : { + "af-south-1" : { }, + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, @@ -4518,10 +9051,24 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, - "ca-central-1" : { }, + "ap-southeast-3" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "rds-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "ca-central-1-fips" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "deprecated" : true, + "hostname" : "rds-fips.ca-central-1.amazonaws.com" + }, "eu-central-1" : { }, "eu-north-1" : { }, "eu-south-1" : { }, @@ -4531,41 +9078,143 @@ "me-south-1" : { }, "rds-fips.ca-central-1" : { "credentialScope" : { - "region" : "ca-central-1" + "region" : "ca-central-1" + }, + "deprecated" : true, + "hostname" : "rds-fips.ca-central-1.amazonaws.com" + }, + "rds-fips.us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "rds-fips.us-east-1.amazonaws.com" + }, + "rds-fips.us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "hostname" : "rds-fips.us-east-2.amazonaws.com" + }, + "rds-fips.us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "deprecated" : true, + "hostname" : "rds-fips.us-west-1.amazonaws.com" + }, + "rds-fips.us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "hostname" : "rds-fips.us-west-2.amazonaws.com" + }, + "rds.ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "deprecated" : true, + "variants" : [ { + "hostname" : "rds-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "rds.us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "variants" : [ { + "hostname" : "rds-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "rds.us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "variants" : [ { + "hostname" : "rds-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "rds.us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "deprecated" : true, + "variants" : [ { + "hostname" : "rds-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "rds.us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" }, - "hostname" : "rds-fips.ca-central-1.amazonaws.com" + "deprecated" : true, + "variants" : [ { + "hostname" : "rds-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] }, - "rds-fips.us-east-1" : { + "sa-east-1" : { }, + "us-east-1" : { + "sslCommonName" : "{service}.{dnsSuffix}", + "variants" : [ { + "hostname" : "rds-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-1-fips" : { "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "rds-fips.us-east-1.amazonaws.com" }, - "rds-fips.us-east-2" : { + "us-east-2" : { + "variants" : [ { + "hostname" : "rds-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2-fips" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "rds-fips.us-east-2.amazonaws.com" }, - "rds-fips.us-west-1" : { + "us-west-1" : { + "variants" : [ { + "hostname" : "rds-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1-fips" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "rds-fips.us-west-1.amazonaws.com" }, - "rds-fips.us-west-2" : { + "us-west-2" : { + "variants" : [ { + "hostname" : "rds-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2-fips" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "rds-fips.us-west-2.amazonaws.com" - }, - "sa-east-1" : { }, - "us-east-1" : { - "sslCommonName" : "{service}.{dnsSuffix}" - }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + } } }, "redshift" : { @@ -4574,10 +9223,17 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, - "ca-central-1" : { }, + "ap-southeast-3" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "redshift-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "eu-central-1" : { }, "eu-north-1" : { }, "eu-south-1" : { }, @@ -4588,38 +9244,63 @@ "credentialScope" : { "region" : "ca-central-1" }, + "deprecated" : true, "hostname" : "redshift-fips.ca-central-1.amazonaws.com" }, "fips-us-east-1" : { "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "redshift-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "redshift-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "redshift-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "redshift-fips.us-west-2.amazonaws.com" }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "redshift-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "redshift-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "redshift-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "redshift-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "rekognition" : { @@ -4629,7 +9310,19 @@ "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, - "ca-central-1" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "rekognition-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "ca-central-1-fips" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "deprecated" : true, + "hostname" : "rekognition-fips.ca-central-1.amazonaws.com" + }, "eu-central-1" : { }, "eu-west-1" : { }, "eu-west-2" : { }, @@ -4637,36 +9330,139 @@ "credentialScope" : { "region" : "ca-central-1" }, + "deprecated" : true, "hostname" : "rekognition-fips.ca-central-1.amazonaws.com" }, "rekognition-fips.us-east-1" : { "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "rekognition-fips.us-east-1.amazonaws.com" }, "rekognition-fips.us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "rekognition-fips.us-east-2.amazonaws.com" }, "rekognition-fips.us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "rekognition-fips.us-west-1.amazonaws.com" }, "rekognition-fips.us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "rekognition-fips.us-west-2.amazonaws.com" }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "rekognition.ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "deprecated" : true, + "variants" : [ { + "hostname" : "rekognition-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "rekognition.us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "variants" : [ { + "hostname" : "rekognition-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "rekognition.us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "variants" : [ { + "hostname" : "rekognition-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "rekognition.us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "deprecated" : true, + "variants" : [ { + "hostname" : "rekognition-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "rekognition.us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "variants" : [ { + "hostname" : "rekognition-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-1" : { + "variants" : [ { + "hostname" : "rekognition-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-1-fips" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "rekognition-fips.us-east-1.amazonaws.com" + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "rekognition-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2-fips" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "hostname" : "rekognition-fips.us-east-2.amazonaws.com" + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "rekognition-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1-fips" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "deprecated" : true, + "hostname" : "rekognition-fips.us-west-1.amazonaws.com" + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "rekognition-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2-fips" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "hostname" : "rekognition-fips.us-west-2.amazonaws.com" + } } }, "resource-groups" : { @@ -4675,9 +9471,11 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-3" : { }, "ca-central-1" : { }, "eu-central-1" : { }, "eu-north-1" : { }, @@ -4689,32 +9487,56 @@ "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "resource-groups-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "resource-groups-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "resource-groups-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "resource-groups-fips.us-west-2.amazonaws.com" }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "resource-groups-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "resource-groups-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "resource-groups-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "resource-groups-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "robomaker" : { @@ -4734,18 +9556,33 @@ "credentialScope" : { "region" : "us-east-1" }, - "hostname" : "route53.amazonaws.com" + "hostname" : "route53.amazonaws.com", + "variants" : [ { + "hostname" : "route53-fips.amazonaws.com", + "tags" : [ "fips" ] + } ] }, "fips-aws-global" : { "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "route53-fips.amazonaws.com" } }, "isRegionalized" : false, "partitionEndpoint" : "aws-global" }, + "route53-recovery-control-config" : { + "endpoints" : { + "aws-global" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "route53-recovery-control-config.us-west-2.amazonaws.com" + } + } + }, "route53domains" : { "endpoints" : { "us-east-1" : { } @@ -4760,6 +9597,7 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, @@ -4778,11 +9616,44 @@ "us-west-2" : { } } }, + "rum" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-2" : { } + } + }, + "runtime-v2-lex" : { + "endpoints" : { + "af-south-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "us-east-1" : { }, + "us-west-2" : { } + } + }, "runtime.lex" : { "defaults" : { "credentialScope" : { "service" : "lex" - } + }, + "variants" : [ { + "hostname" : "runtime-fips.lex.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] }, "endpoints" : { "ap-northeast-1" : { }, @@ -4791,16 +9662,47 @@ "eu-central-1" : { }, "eu-west-1" : { }, "eu-west-2" : { }, - "us-east-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "runtime-fips.lex.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-1-fips" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "runtime-fips.lex.us-east-1.amazonaws.com" + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "runtime-fips.lex.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2-fips" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "hostname" : "runtime-fips.lex.us-west-2.amazonaws.com" + } } }, "runtime.sagemaker" : { + "defaults" : { + "variants" : [ { + "hostname" : "runtime-fips.sagemaker.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] + }, "endpoints" : { "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, @@ -4813,32 +9715,56 @@ "eu-west-3" : { }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, + "us-east-1" : { + "variants" : [ { + "hostname" : "runtime-fips.sagemaker.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-east-1-fips" : { "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "runtime-fips.sagemaker.us-east-1.amazonaws.com" }, - "us-east-2" : { }, + "us-east-2" : { + "variants" : [ { + "hostname" : "runtime-fips.sagemaker.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-east-2-fips" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "runtime-fips.sagemaker.us-east-2.amazonaws.com" }, - "us-west-1" : { }, + "us-west-1" : { + "variants" : [ { + "hostname" : "runtime-fips.sagemaker.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-west-1-fips" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "runtime-fips.sagemaker.us-west-1.amazonaws.com" }, - "us-west-2" : { }, + "us-west-2" : { + "variants" : [ { + "hostname" : "runtime-fips.sagemaker.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-west-2-fips" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "runtime-fips.sagemaker.us-west-2.amazonaws.com" } } @@ -4846,24 +9772,77 @@ "s3" : { "defaults" : { "protocols" : [ "http", "https" ], - "signatureVersions" : [ "s3v4" ] + "signatureVersions" : [ "s3v4" ], + "variants" : [ { + "dnsSuffix" : "amazonaws.com", + "hostname" : "{service}-fips.dualstack.{region}.{dnsSuffix}", + "tags" : [ "dualstack", "fips" ] + }, { + "dnsSuffix" : "amazonaws.com", + "hostname" : "{service}.dualstack.{region}.{dnsSuffix}", + "tags" : [ "dualstack" ] + } ] }, "endpoints" : { - "af-south-1" : { }, - "ap-east-1" : { }, + "af-south-1" : { + "variants" : [ { + "hostname" : "s3.dualstack.af-south-1.amazonaws.com", + "tags" : [ "dualstack" ] + } ] + }, + "ap-east-1" : { + "variants" : [ { + "hostname" : "s3.dualstack.ap-east-1.amazonaws.com", + "tags" : [ "dualstack" ] + } ] + }, "ap-northeast-1" : { "hostname" : "s3.ap-northeast-1.amazonaws.com", - "signatureVersions" : [ "s3", "s3v4" ] + "signatureVersions" : [ "s3", "s3v4" ], + "variants" : [ { + "hostname" : "s3.dualstack.ap-northeast-1.amazonaws.com", + "tags" : [ "dualstack" ] + } ] + }, + "ap-northeast-2" : { + "variants" : [ { + "hostname" : "s3.dualstack.ap-northeast-2.amazonaws.com", + "tags" : [ "dualstack" ] + } ] + }, + "ap-northeast-3" : { + "variants" : [ { + "hostname" : "s3.dualstack.ap-northeast-3.amazonaws.com", + "tags" : [ "dualstack" ] + } ] + }, + "ap-south-1" : { + "variants" : [ { + "hostname" : "s3.dualstack.ap-south-1.amazonaws.com", + "tags" : [ "dualstack" ] + } ] }, - "ap-northeast-2" : { }, - "ap-south-1" : { }, "ap-southeast-1" : { "hostname" : "s3.ap-southeast-1.amazonaws.com", - "signatureVersions" : [ "s3", "s3v4" ] + "signatureVersions" : [ "s3", "s3v4" ], + "variants" : [ { + "hostname" : "s3.dualstack.ap-southeast-1.amazonaws.com", + "tags" : [ "dualstack" ] + } ] }, "ap-southeast-2" : { "hostname" : "s3.ap-southeast-2.amazonaws.com", - "signatureVersions" : [ "s3", "s3v4" ] + "signatureVersions" : [ "s3", "s3v4" ], + "variants" : [ { + "hostname" : "s3.dualstack.ap-southeast-2.amazonaws.com", + "tags" : [ "dualstack" ] + } ] + }, + "ap-southeast-3" : { + "variants" : [ { + "hostname" : "s3.dualstack.ap-southeast-3.amazonaws.com", + "tags" : [ "dualstack" ] + } ] }, "aws-global" : { "credentialScope" : { @@ -4872,17 +9851,97 @@ "hostname" : "s3.amazonaws.com", "signatureVersions" : [ "s3", "s3v4" ] }, - "ca-central-1" : { }, - "eu-central-1" : { }, - "eu-north-1" : { }, - "eu-south-1" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "s3-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + }, { + "hostname" : "s3-fips.dualstack.ca-central-1.amazonaws.com", + "tags" : [ "dualstack", "fips" ] + }, { + "hostname" : "s3.dualstack.ca-central-1.amazonaws.com", + "tags" : [ "dualstack" ] + } ] + }, + "eu-central-1" : { + "variants" : [ { + "hostname" : "s3.dualstack.eu-central-1.amazonaws.com", + "tags" : [ "dualstack" ] + } ] + }, + "eu-north-1" : { + "variants" : [ { + "hostname" : "s3.dualstack.eu-north-1.amazonaws.com", + "tags" : [ "dualstack" ] + } ] + }, + "eu-south-1" : { + "variants" : [ { + "hostname" : "s3.dualstack.eu-south-1.amazonaws.com", + "tags" : [ "dualstack" ] + } ] + }, "eu-west-1" : { "hostname" : "s3.eu-west-1.amazonaws.com", - "signatureVersions" : [ "s3", "s3v4" ] + "signatureVersions" : [ "s3", "s3v4" ], + "variants" : [ { + "hostname" : "s3.dualstack.eu-west-1.amazonaws.com", + "tags" : [ "dualstack" ] + } ] + }, + "eu-west-2" : { + "variants" : [ { + "hostname" : "s3.dualstack.eu-west-2.amazonaws.com", + "tags" : [ "dualstack" ] + } ] + }, + "eu-west-3" : { + "variants" : [ { + "hostname" : "s3.dualstack.eu-west-3.amazonaws.com", + "tags" : [ "dualstack" ] + } ] + }, + "fips-ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "deprecated" : true, + "hostname" : "s3-fips.ca-central-1.amazonaws.com" + }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "s3-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "hostname" : "s3-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "deprecated" : true, + "hostname" : "s3-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "hostname" : "s3-fips.us-west-2.amazonaws.com" + }, + "me-south-1" : { + "variants" : [ { + "hostname" : "s3.dualstack.me-south-1.amazonaws.com", + "tags" : [ "dualstack" ] + } ] }, - "eu-west-2" : { }, - "eu-west-3" : { }, - "me-south-1" : { }, "s3-external-1" : { "credentialScope" : { "region" : "us-east-1" @@ -4892,20 +9951,65 @@ }, "sa-east-1" : { "hostname" : "s3.sa-east-1.amazonaws.com", - "signatureVersions" : [ "s3", "s3v4" ] + "signatureVersions" : [ "s3", "s3v4" ], + "variants" : [ { + "hostname" : "s3.dualstack.sa-east-1.amazonaws.com", + "tags" : [ "dualstack" ] + } ] }, "us-east-1" : { "hostname" : "s3.us-east-1.amazonaws.com", - "signatureVersions" : [ "s3", "s3v4" ] + "signatureVersions" : [ "s3", "s3v4" ], + "variants" : [ { + "hostname" : "s3-fips.dualstack.us-east-1.amazonaws.com", + "tags" : [ "dualstack", "fips" ] + }, { + "hostname" : "s3-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + }, { + "hostname" : "s3.dualstack.us-east-1.amazonaws.com", + "tags" : [ "dualstack" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "s3-fips.dualstack.us-east-2.amazonaws.com", + "tags" : [ "dualstack", "fips" ] + }, { + "hostname" : "s3-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + }, { + "hostname" : "s3.dualstack.us-east-2.amazonaws.com", + "tags" : [ "dualstack" ] + } ] }, - "us-east-2" : { }, "us-west-1" : { "hostname" : "s3.us-west-1.amazonaws.com", - "signatureVersions" : [ "s3", "s3v4" ] + "signatureVersions" : [ "s3", "s3v4" ], + "variants" : [ { + "hostname" : "s3-fips.dualstack.us-west-1.amazonaws.com", + "tags" : [ "dualstack", "fips" ] + }, { + "hostname" : "s3-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + }, { + "hostname" : "s3.dualstack.us-west-1.amazonaws.com", + "tags" : [ "dualstack" ] + } ] }, "us-west-2" : { "hostname" : "s3.us-west-2.amazonaws.com", - "signatureVersions" : [ "s3", "s3v4" ] + "signatureVersions" : [ "s3", "s3v4" ], + "variants" : [ { + "hostname" : "s3-fips.dualstack.us-west-2.amazonaws.com", + "tags" : [ "dualstack", "fips" ] + }, { + "hostname" : "s3-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + }, { + "hostname" : "s3.dualstack.us-west-2.amazonaws.com", + "tags" : [ "dualstack" ] + } ] } }, "isRegionalized" : true, @@ -4914,7 +10018,16 @@ "s3-control" : { "defaults" : { "protocols" : [ "https" ], - "signatureVersions" : [ "s3v4" ] + "signatureVersions" : [ "s3v4" ], + "variants" : [ { + "dnsSuffix" : "amazonaws.com", + "hostname" : "{service}-fips.dualstack.{region}.{dnsSuffix}", + "tags" : [ "dualstack", "fips" ] + }, { + "dnsSuffix" : "amazonaws.com", + "hostname" : "{service}.dualstack.{region}.{dnsSuffix}", + "tags" : [ "dualstack" ] + } ] }, "endpoints" : { "ap-northeast-1" : { @@ -4922,47 +10035,89 @@ "region" : "ap-northeast-1" }, "hostname" : "s3-control.ap-northeast-1.amazonaws.com", - "signatureVersions" : [ "s3v4" ] + "signatureVersions" : [ "s3v4" ], + "variants" : [ { + "hostname" : "s3-control.dualstack.ap-northeast-1.amazonaws.com", + "tags" : [ "dualstack" ] + } ] }, "ap-northeast-2" : { "credentialScope" : { "region" : "ap-northeast-2" }, "hostname" : "s3-control.ap-northeast-2.amazonaws.com", - "signatureVersions" : [ "s3v4" ] + "signatureVersions" : [ "s3v4" ], + "variants" : [ { + "hostname" : "s3-control.dualstack.ap-northeast-2.amazonaws.com", + "tags" : [ "dualstack" ] + } ] + }, + "ap-northeast-3" : { + "credentialScope" : { + "region" : "ap-northeast-3" + }, + "hostname" : "s3-control.ap-northeast-3.amazonaws.com", + "signatureVersions" : [ "s3v4" ], + "variants" : [ { + "hostname" : "s3-control.dualstack.ap-northeast-3.amazonaws.com", + "tags" : [ "dualstack" ] + } ] }, "ap-south-1" : { "credentialScope" : { "region" : "ap-south-1" }, "hostname" : "s3-control.ap-south-1.amazonaws.com", - "signatureVersions" : [ "s3v4" ] + "signatureVersions" : [ "s3v4" ], + "variants" : [ { + "hostname" : "s3-control.dualstack.ap-south-1.amazonaws.com", + "tags" : [ "dualstack" ] + } ] }, "ap-southeast-1" : { "credentialScope" : { "region" : "ap-southeast-1" }, "hostname" : "s3-control.ap-southeast-1.amazonaws.com", - "signatureVersions" : [ "s3v4" ] + "signatureVersions" : [ "s3v4" ], + "variants" : [ { + "hostname" : "s3-control.dualstack.ap-southeast-1.amazonaws.com", + "tags" : [ "dualstack" ] + } ] }, "ap-southeast-2" : { "credentialScope" : { "region" : "ap-southeast-2" }, "hostname" : "s3-control.ap-southeast-2.amazonaws.com", - "signatureVersions" : [ "s3v4" ] + "signatureVersions" : [ "s3v4" ], + "variants" : [ { + "hostname" : "s3-control.dualstack.ap-southeast-2.amazonaws.com", + "tags" : [ "dualstack" ] + } ] }, "ca-central-1" : { "credentialScope" : { "region" : "ca-central-1" }, "hostname" : "s3-control.ca-central-1.amazonaws.com", - "signatureVersions" : [ "s3v4" ] + "signatureVersions" : [ "s3v4" ], + "variants" : [ { + "hostname" : "s3-control-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + }, { + "hostname" : "s3-control-fips.dualstack.ca-central-1.amazonaws.com", + "tags" : [ "dualstack", "fips" ] + }, { + "hostname" : "s3-control.dualstack.ca-central-1.amazonaws.com", + "tags" : [ "dualstack" ] + } ] }, "ca-central-1-fips" : { "credentialScope" : { "region" : "ca-central-1" }, + "deprecated" : true, "hostname" : "s3-control-fips.ca-central-1.amazonaws.com", "signatureVersions" : [ "s3v4" ] }, @@ -4971,54 +10126,89 @@ "region" : "eu-central-1" }, "hostname" : "s3-control.eu-central-1.amazonaws.com", - "signatureVersions" : [ "s3v4" ] + "signatureVersions" : [ "s3v4" ], + "variants" : [ { + "hostname" : "s3-control.dualstack.eu-central-1.amazonaws.com", + "tags" : [ "dualstack" ] + } ] }, "eu-north-1" : { "credentialScope" : { "region" : "eu-north-1" }, "hostname" : "s3-control.eu-north-1.amazonaws.com", - "signatureVersions" : [ "s3v4" ] + "signatureVersions" : [ "s3v4" ], + "variants" : [ { + "hostname" : "s3-control.dualstack.eu-north-1.amazonaws.com", + "tags" : [ "dualstack" ] + } ] }, "eu-west-1" : { "credentialScope" : { "region" : "eu-west-1" }, "hostname" : "s3-control.eu-west-1.amazonaws.com", - "signatureVersions" : [ "s3v4" ] + "signatureVersions" : [ "s3v4" ], + "variants" : [ { + "hostname" : "s3-control.dualstack.eu-west-1.amazonaws.com", + "tags" : [ "dualstack" ] + } ] }, "eu-west-2" : { "credentialScope" : { "region" : "eu-west-2" }, "hostname" : "s3-control.eu-west-2.amazonaws.com", - "signatureVersions" : [ "s3v4" ] + "signatureVersions" : [ "s3v4" ], + "variants" : [ { + "hostname" : "s3-control.dualstack.eu-west-2.amazonaws.com", + "tags" : [ "dualstack" ] + } ] }, "eu-west-3" : { "credentialScope" : { "region" : "eu-west-3" }, "hostname" : "s3-control.eu-west-3.amazonaws.com", - "signatureVersions" : [ "s3v4" ] + "signatureVersions" : [ "s3v4" ], + "variants" : [ { + "hostname" : "s3-control.dualstack.eu-west-3.amazonaws.com", + "tags" : [ "dualstack" ] + } ] }, "sa-east-1" : { "credentialScope" : { "region" : "sa-east-1" }, "hostname" : "s3-control.sa-east-1.amazonaws.com", - "signatureVersions" : [ "s3v4" ] + "signatureVersions" : [ "s3v4" ], + "variants" : [ { + "hostname" : "s3-control.dualstack.sa-east-1.amazonaws.com", + "tags" : [ "dualstack" ] + } ] }, "us-east-1" : { "credentialScope" : { "region" : "us-east-1" }, "hostname" : "s3-control.us-east-1.amazonaws.com", - "signatureVersions" : [ "s3v4" ] + "signatureVersions" : [ "s3v4" ], + "variants" : [ { + "hostname" : "s3-control-fips.dualstack.us-east-1.amazonaws.com", + "tags" : [ "dualstack", "fips" ] + }, { + "hostname" : "s3-control-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + }, { + "hostname" : "s3-control.dualstack.us-east-1.amazonaws.com", + "tags" : [ "dualstack" ] + } ] }, "us-east-1-fips" : { "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "s3-control-fips.us-east-1.amazonaws.com", "signatureVersions" : [ "s3v4" ] }, @@ -5027,12 +10217,23 @@ "region" : "us-east-2" }, "hostname" : "s3-control.us-east-2.amazonaws.com", - "signatureVersions" : [ "s3v4" ] + "signatureVersions" : [ "s3v4" ], + "variants" : [ { + "hostname" : "s3-control-fips.dualstack.us-east-2.amazonaws.com", + "tags" : [ "dualstack", "fips" ] + }, { + "hostname" : "s3-control-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + }, { + "hostname" : "s3-control.dualstack.us-east-2.amazonaws.com", + "tags" : [ "dualstack" ] + } ] }, "us-east-2-fips" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "s3-control-fips.us-east-2.amazonaws.com", "signatureVersions" : [ "s3v4" ] }, @@ -5041,12 +10242,23 @@ "region" : "us-west-1" }, "hostname" : "s3-control.us-west-1.amazonaws.com", - "signatureVersions" : [ "s3v4" ] + "signatureVersions" : [ "s3v4" ], + "variants" : [ { + "hostname" : "s3-control-fips.dualstack.us-west-1.amazonaws.com", + "tags" : [ "dualstack", "fips" ] + }, { + "hostname" : "s3-control-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + }, { + "hostname" : "s3-control.dualstack.us-west-1.amazonaws.com", + "tags" : [ "dualstack" ] + } ] }, "us-west-1-fips" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "s3-control-fips.us-west-1.amazonaws.com", "signatureVersions" : [ "s3v4" ] }, @@ -5055,17 +10267,88 @@ "region" : "us-west-2" }, "hostname" : "s3-control.us-west-2.amazonaws.com", - "signatureVersions" : [ "s3v4" ] + "signatureVersions" : [ "s3v4" ], + "variants" : [ { + "hostname" : "s3-control-fips.dualstack.us-west-2.amazonaws.com", + "tags" : [ "dualstack", "fips" ] + }, { + "hostname" : "s3-control-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + }, { + "hostname" : "s3-control.dualstack.us-west-2.amazonaws.com", + "tags" : [ "dualstack" ] + } ] }, "us-west-2-fips" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "s3-control-fips.us-west-2.amazonaws.com", "signatureVersions" : [ "s3v4" ] } } }, + "s3-outposts" : { + "endpoints" : { + "af-south-1" : { }, + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-northeast-3" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { + "variants" : [ { + "tags" : [ "fips" ] + } ] + }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-south-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "fips-ca-central-1" : { + "deprecated" : true + }, + "fips-us-east-1" : { + "deprecated" : true + }, + "fips-us-east-2" : { + "deprecated" : true + }, + "fips-us-west-1" : { + "deprecated" : true + }, + "fips-us-west-2" : { + "deprecated" : true + }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { + "variants" : [ { + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "tags" : [ "fips" ] + } ] + } + } + }, "savingsplans" : { "endpoints" : { "aws-global" : { @@ -5123,10 +10406,24 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, - "ca-central-1" : { }, + "ap-southeast-3" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "secretsmanager-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "ca-central-1-fips" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "deprecated" : true, + "hostname" : "secretsmanager-fips.ca-central-1.amazonaws.com" + }, "eu-central-1" : { }, "eu-north-1" : { }, "eu-south-1" : { }, @@ -5135,32 +10432,56 @@ "eu-west-3" : { }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, + "us-east-1" : { + "variants" : [ { + "hostname" : "secretsmanager-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-east-1-fips" : { "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "secretsmanager-fips.us-east-1.amazonaws.com" }, - "us-east-2" : { }, + "us-east-2" : { + "variants" : [ { + "hostname" : "secretsmanager-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-east-2-fips" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "secretsmanager-fips.us-east-2.amazonaws.com" }, - "us-west-1" : { }, + "us-west-1" : { + "variants" : [ { + "hostname" : "secretsmanager-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-west-1-fips" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "secretsmanager-fips.us-west-1.amazonaws.com" }, - "us-west-2" : { }, + "us-west-2" : { + "variants" : [ { + "hostname" : "secretsmanager-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-west-2-fips" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "secretsmanager-fips.us-west-2.amazonaws.com" } } @@ -5171,6 +10492,7 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, @@ -5185,32 +10507,56 @@ "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "securityhub-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "securityhub-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "securityhub-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "securityhub-fips.us-west-2.amazonaws.com" }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "securityhub-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "securityhub-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "securityhub-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "securityhub-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "serverlessrepo" : { @@ -5280,6 +10626,7 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, @@ -5292,62 +10639,243 @@ "eu-west-3" : { }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, + "us-east-1" : { + "variants" : [ { + "hostname" : "servicecatalog-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-east-1-fips" : { "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "servicecatalog-fips.us-east-1.amazonaws.com" }, - "us-east-2" : { }, + "us-east-2" : { + "variants" : [ { + "hostname" : "servicecatalog-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-east-2-fips" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "servicecatalog-fips.us-east-2.amazonaws.com" }, - "us-west-1" : { }, + "us-west-1" : { + "variants" : [ { + "hostname" : "servicecatalog-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-west-1-fips" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "servicecatalog-fips.us-west-1.amazonaws.com" }, - "us-west-2" : { }, + "us-west-2" : { + "variants" : [ { + "hostname" : "servicecatalog-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-west-2-fips" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "servicecatalog-fips.us-west-2.amazonaws.com" } } }, + "servicecatalog-appregistry" : { + "endpoints" : { + "af-south-1" : { }, + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "servicecatalog-appregistry-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-south-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "fips-ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "deprecated" : true, + "hostname" : "servicecatalog-appregistry-fips.ca-central-1.amazonaws.com" + }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "servicecatalog-appregistry-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "hostname" : "servicecatalog-appregistry-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "deprecated" : true, + "hostname" : "servicecatalog-appregistry-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "hostname" : "servicecatalog-appregistry-fips.us-west-2.amazonaws.com" + }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { + "variants" : [ { + "hostname" : "servicecatalog-appregistry-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "servicecatalog-appregistry-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "servicecatalog-appregistry-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "servicecatalog-appregistry-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, "servicediscovery" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, - "ca-central-1" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "servicediscovery-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "ca-central-1-fips" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "deprecated" : true, + "hostname" : "servicediscovery-fips.ca-central-1.amazonaws.com" + }, "eu-central-1" : { }, "eu-north-1" : { }, + "eu-south-1" : { }, "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, "me-south-1" : { }, "sa-east-1" : { }, + "servicediscovery" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "deprecated" : true, + "variants" : [ { + "hostname" : "servicediscovery-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "servicediscovery-fips" : { "credentialScope" : { "region" : "ca-central-1" }, + "deprecated" : true, "hostname" : "servicediscovery-fips.ca-central-1.amazonaws.com" }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "servicediscovery-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-1-fips" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "servicediscovery-fips.us-east-1.amazonaws.com" + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "servicediscovery-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2-fips" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "hostname" : "servicediscovery-fips.us-east-2.amazonaws.com" + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "servicediscovery-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1-fips" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "deprecated" : true, + "hostname" : "servicediscovery-fips.us-west-1.amazonaws.com" + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "servicediscovery-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2-fips" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "hostname" : "servicediscovery-fips.us-west-2.amazonaws.com" + } } }, "servicequotas" : { @@ -5359,6 +10887,7 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, @@ -5383,11 +10912,49 @@ "ap-northeast-2" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ca-central-1" : { }, "eu-central-1" : { }, "eu-west-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-2" : { } + "eu-west-2" : { }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "session.qldb-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "hostname" : "session.qldb-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "hostname" : "session.qldb-fips.us-west-2.amazonaws.com" + }, + "us-east-1" : { + "variants" : [ { + "hostname" : "session.qldb-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "session.qldb-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "session.qldb-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "shield" : { @@ -5400,12 +10967,17 @@ "credentialScope" : { "region" : "us-east-1" }, - "hostname" : "shield.us-east-1.amazonaws.com" + "hostname" : "shield.us-east-1.amazonaws.com", + "variants" : [ { + "hostname" : "shield-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] }, "fips-aws-global" : { "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "shield-fips.us-east-1.amazonaws.com" } }, @@ -5432,151 +11004,272 @@ "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "sms-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "sms-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "sms-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "sms-fips.us-west-2.amazonaws.com" }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "sms-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "sms-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "sms-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "sms-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "snowball" : { "endpoints" : { "af-south-1" : { }, "ap-east-1" : { }, - "ap-northeast-1" : { }, - "ap-northeast-2" : { }, - "ap-south-1" : { }, - "ap-southeast-1" : { }, - "ap-southeast-2" : { }, - "ca-central-1" : { }, - "eu-central-1" : { }, + "ap-northeast-1" : { + "variants" : [ { + "hostname" : "snowball-fips.ap-northeast-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "ap-northeast-2" : { + "variants" : [ { + "hostname" : "snowball-fips.ap-northeast-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "ap-northeast-3" : { + "variants" : [ { + "hostname" : "snowball-fips.ap-northeast-3.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "ap-south-1" : { + "variants" : [ { + "hostname" : "snowball-fips.ap-south-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "ap-southeast-1" : { + "variants" : [ { + "hostname" : "snowball-fips.ap-southeast-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "ap-southeast-2" : { + "variants" : [ { + "hostname" : "snowball-fips.ap-southeast-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "snowball-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "eu-central-1" : { + "variants" : [ { + "hostname" : "snowball-fips.eu-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "eu-north-1" : { }, "eu-south-1" : { }, - "eu-west-1" : { }, - "eu-west-2" : { }, - "eu-west-3" : { }, + "eu-west-1" : { + "variants" : [ { + "hostname" : "snowball-fips.eu-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "eu-west-2" : { + "variants" : [ { + "hostname" : "snowball-fips.eu-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "eu-west-3" : { + "variants" : [ { + "hostname" : "snowball-fips.eu-west-3.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "fips-ap-northeast-1" : { "credentialScope" : { "region" : "ap-northeast-1" }, + "deprecated" : true, "hostname" : "snowball-fips.ap-northeast-1.amazonaws.com" }, "fips-ap-northeast-2" : { "credentialScope" : { "region" : "ap-northeast-2" }, + "deprecated" : true, "hostname" : "snowball-fips.ap-northeast-2.amazonaws.com" }, "fips-ap-northeast-3" : { "credentialScope" : { "region" : "ap-northeast-3" }, + "deprecated" : true, "hostname" : "snowball-fips.ap-northeast-3.amazonaws.com" }, "fips-ap-south-1" : { "credentialScope" : { "region" : "ap-south-1" }, + "deprecated" : true, "hostname" : "snowball-fips.ap-south-1.amazonaws.com" }, "fips-ap-southeast-1" : { "credentialScope" : { "region" : "ap-southeast-1" }, + "deprecated" : true, "hostname" : "snowball-fips.ap-southeast-1.amazonaws.com" }, "fips-ap-southeast-2" : { "credentialScope" : { "region" : "ap-southeast-2" }, + "deprecated" : true, "hostname" : "snowball-fips.ap-southeast-2.amazonaws.com" }, "fips-ca-central-1" : { "credentialScope" : { "region" : "ca-central-1" }, + "deprecated" : true, "hostname" : "snowball-fips.ca-central-1.amazonaws.com" }, "fips-eu-central-1" : { "credentialScope" : { "region" : "eu-central-1" }, + "deprecated" : true, "hostname" : "snowball-fips.eu-central-1.amazonaws.com" }, "fips-eu-west-1" : { "credentialScope" : { "region" : "eu-west-1" }, + "deprecated" : true, "hostname" : "snowball-fips.eu-west-1.amazonaws.com" }, "fips-eu-west-2" : { "credentialScope" : { "region" : "eu-west-2" }, + "deprecated" : true, "hostname" : "snowball-fips.eu-west-2.amazonaws.com" }, "fips-eu-west-3" : { "credentialScope" : { "region" : "eu-west-3" }, + "deprecated" : true, "hostname" : "snowball-fips.eu-west-3.amazonaws.com" }, "fips-sa-east-1" : { "credentialScope" : { "region" : "sa-east-1" }, + "deprecated" : true, "hostname" : "snowball-fips.sa-east-1.amazonaws.com" }, "fips-us-east-1" : { "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "snowball-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "snowball-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "snowball-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "snowball-fips.us-west-2.amazonaws.com" }, - "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "sa-east-1" : { + "variants" : [ { + "hostname" : "snowball-fips.sa-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-1" : { + "variants" : [ { + "hostname" : "snowball-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "snowball-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "snowball-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "snowball-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "sns" : { @@ -5588,9 +11281,11 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-3" : { }, "ca-central-1" : { }, "eu-central-1" : { }, "eu-north-1" : { }, @@ -5602,32 +11297,56 @@ "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "sns-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "sns-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "sns-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "sns-fips.us-west-2.amazonaws.com" }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "sns-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "sns-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "sns-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "sns-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "sqs" : { @@ -5640,9 +11359,11 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-3" : { }, "ca-central-1" : { }, "eu-central-1" : { }, "eu-north-1" : { }, @@ -5654,34 +11375,57 @@ "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "sqs-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "sqs-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "sqs-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "sqs-fips.us-west-2.amazonaws.com" }, "me-south-1" : { }, "sa-east-1" : { }, "us-east-1" : { - "sslCommonName" : "queue.{dnsSuffix}" + "sslCommonName" : "queue.{dnsSuffix}", + "variants" : [ { + "hostname" : "sqs-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-2" : { + "variants" : [ { + "hostname" : "sqs-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "sqs-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "sqs-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "ssm" : { @@ -5690,10 +11434,17 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, - "ca-central-1" : { }, + "ap-southeast-3" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "ssm-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "eu-central-1" : { }, "eu-north-1" : { }, "eu-south-1" : { }, @@ -5704,34 +11455,79 @@ "credentialScope" : { "region" : "ca-central-1" }, + "deprecated" : true, "hostname" : "ssm-fips.ca-central-1.amazonaws.com" }, "fips-us-east-1" : { "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "ssm-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "ssm-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "ssm-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "ssm-fips.us-west-2.amazonaws.com" }, "me-south-1" : { }, "sa-east-1" : { }, + "us-east-1" : { + "variants" : [ { + "hostname" : "ssm-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "ssm-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "ssm-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "ssm-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, + "ssm-incidents" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "sa-east-1" : { }, "us-east-1" : { }, "us-east-2" : { }, "us-west-1" : { }, @@ -5744,9 +11540,11 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-3" : { }, "ca-central-1" : { }, "eu-central-1" : { }, "eu-north-1" : { }, @@ -5758,32 +11556,56 @@ "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "states-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "states-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "states-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "states-fips.us-west-2.amazonaws.com" }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "states-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "states-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "states-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "states-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "storagegateway" : { @@ -5792,10 +11614,24 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, - "ca-central-1" : { }, + "ap-southeast-3" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "storagegateway-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "ca-central-1-fips" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "deprecated" : true, + "hostname" : "storagegateway-fips.ca-central-1.amazonaws.com" + }, "eu-central-1" : { }, "eu-north-1" : { }, "eu-south-1" : { }, @@ -5806,14 +11642,63 @@ "credentialScope" : { "region" : "ca-central-1" }, + "deprecated" : true, "hostname" : "storagegateway-fips.ca-central-1.amazonaws.com" }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "storagegateway-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-1-fips" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "storagegateway-fips.us-east-1.amazonaws.com" + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "storagegateway-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2-fips" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "hostname" : "storagegateway-fips.us-east-2.amazonaws.com" + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "storagegateway-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1-fips" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "deprecated" : true, + "hostname" : "storagegateway-fips.us-west-1.amazonaws.com" + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "storagegateway-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2-fips" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "hostname" : "storagegateway-fips.us-west-2.amazonaws.com" + } } }, "streams.dynamodb" : { @@ -5824,20 +11709,19 @@ "protocols" : [ "http", "https" ] }, "endpoints" : { + "af-south-1" : { }, + "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-3" : { }, "ca-central-1" : { }, - "ca-central-1-fips" : { - "credentialScope" : { - "region" : "ca-central-1" - }, - "hostname" : "dynamodb-fips.ca-central-1.amazonaws.com" - }, "eu-central-1" : { }, "eu-north-1" : { }, + "eu-south-1" : { }, "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, @@ -5851,33 +11735,9 @@ "me-south-1" : { }, "sa-east-1" : { }, "us-east-1" : { }, - "us-east-1-fips" : { - "credentialScope" : { - "region" : "us-east-1" - }, - "hostname" : "dynamodb-fips.us-east-1.amazonaws.com" - }, "us-east-2" : { }, - "us-east-2-fips" : { - "credentialScope" : { - "region" : "us-east-2" - }, - "hostname" : "dynamodb-fips.us-east-2.amazonaws.com" - }, "us-west-1" : { }, - "us-west-1-fips" : { - "credentialScope" : { - "region" : "us-west-1" - }, - "hostname" : "dynamodb-fips.us-west-1.amazonaws.com" - }, - "us-west-2" : { }, - "us-west-2-fips" : { - "credentialScope" : { - "region" : "us-west-2" - }, - "hostname" : "dynamodb-fips.us-west-2.amazonaws.com" - } + "us-west-2" : { } } }, "sts" : { @@ -5886,9 +11746,11 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-3" : { }, "aws-global" : { "credentialScope" : { "region" : "us-east-1" @@ -5904,32 +11766,56 @@ "eu-west-3" : { }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, + "us-east-1" : { + "variants" : [ { + "hostname" : "sts-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-east-1-fips" : { "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "sts-fips.us-east-1.amazonaws.com" }, - "us-east-2" : { }, + "us-east-2" : { + "variants" : [ { + "hostname" : "sts-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-east-2-fips" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "sts-fips.us-east-2.amazonaws.com" }, - "us-west-1" : { }, + "us-west-1" : { + "variants" : [ { + "hostname" : "sts-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-west-1-fips" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "sts-fips.us-west-1.amazonaws.com" }, - "us-west-2" : { }, + "us-west-2" : { + "variants" : [ { + "hostname" : "sts-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-west-2-fips" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "sts-fips.us-west-2.amazonaws.com" } }, @@ -5952,9 +11838,11 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-3" : { }, "ca-central-1" : { }, "eu-central-1" : { }, "eu-north-1" : { }, @@ -5966,28 +11854,78 @@ "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "swf-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "swf-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "swf-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "swf-fips.us-west-2.amazonaws.com" }, "me-south-1" : { }, "sa-east-1" : { }, + "us-east-1" : { + "variants" : [ { + "hostname" : "swf-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "swf-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "swf-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "swf-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, + "synthetics" : { + "endpoints" : { + "af-south-1" : { }, + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-northeast-3" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ap-southeast-3" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-south-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, "us-east-1" : { }, "us-east-2" : { }, "us-west-1" : { }, @@ -6000,9 +11938,11 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-3" : { }, "ca-central-1" : { }, "eu-central-1" : { }, "eu-north-1" : { }, @@ -6018,61 +11958,251 @@ "us-west-2" : { } } }, + "textract" : { + "endpoints" : { + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "textract-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "fips-ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "deprecated" : true, + "hostname" : "textract-fips.ca-central-1.amazonaws.com" + }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "textract-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "hostname" : "textract-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "deprecated" : true, + "hostname" : "textract-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "hostname" : "textract-fips.us-west-2.amazonaws.com" + }, + "us-east-1" : { + "variants" : [ { + "hostname" : "textract-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "textract-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "textract-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "textract-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, "transcribe" : { "defaults" : { - "protocols" : [ "https" ] + "protocols" : [ "https" ], + "variants" : [ { + "hostname" : "fips.transcribe.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] }, "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, - "ca-central-1" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "fips.transcribe.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "eu-central-1" : { }, + "eu-north-1" : { }, "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "fips-ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "deprecated" : true, + "hostname" : "fips.transcribe.ca-central-1.amazonaws.com" + }, "fips-us-east-1" : { "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "fips.transcribe.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "fips.transcribe.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "fips.transcribe.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "fips.transcribe.us-west-2.amazonaws.com" }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "fips.transcribe.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "fips.transcribe.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "fips.transcribe.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "fips.transcribe.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "transcribestreaming" : { "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, "ap-southeast-2" : { }, "ca-central-1" : { }, "eu-central-1" : { }, "eu-west-1" : { }, "eu-west-2" : { }, + "sa-east-1" : { }, + "transcribestreaming-ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "deprecated" : true, + "variants" : [ { + "hostname" : "transcribestreaming-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "transcribestreaming-fips-ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "deprecated" : true, + "hostname" : "transcribestreaming-fips.ca-central-1.amazonaws.com" + }, + "transcribestreaming-fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "transcribestreaming-fips.us-east-1.amazonaws.com" + }, + "transcribestreaming-fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "hostname" : "transcribestreaming-fips.us-east-2.amazonaws.com" + }, + "transcribestreaming-fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "hostname" : "transcribestreaming-fips.us-west-2.amazonaws.com" + }, + "transcribestreaming-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "variants" : [ { + "hostname" : "transcribestreaming-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "transcribestreaming-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "variants" : [ { + "hostname" : "transcribestreaming-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "transcribestreaming-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "variants" : [ { + "hostname" : "transcribestreaming-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-east-1" : { }, "us-east-2" : { }, "us-west-2" : { } @@ -6080,14 +12210,23 @@ }, "transfer" : { "endpoints" : { + "af-south-1" : { }, + "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, - "ca-central-1" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "transfer-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "eu-central-1" : { }, "eu-north-1" : { }, + "eu-south-1" : { }, "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, @@ -6095,37 +12234,63 @@ "credentialScope" : { "region" : "ca-central-1" }, + "deprecated" : true, "hostname" : "transfer-fips.ca-central-1.amazonaws.com" }, "fips-us-east-1" : { "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "transfer-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "transfer-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "transfer-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "transfer-fips.us-west-2.amazonaws.com" }, + "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "transfer-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "transfer-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "transfer-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "transfer-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "translate" : { @@ -6145,43 +12310,94 @@ "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, - "us-east-1" : { }, + "us-east-1" : { + "variants" : [ { + "hostname" : "translate-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-east-1-fips" : { "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "translate-fips.us-east-1.amazonaws.com" }, - "us-east-2" : { }, + "us-east-2" : { + "variants" : [ { + "hostname" : "translate-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-east-2-fips" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "translate-fips.us-east-2.amazonaws.com" }, "us-west-1" : { }, - "us-west-2" : { }, + "us-west-2" : { + "variants" : [ { + "hostname" : "translate-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-west-2-fips" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "translate-fips.us-west-2.amazonaws.com" } } }, + "voiceid" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "eu-central-1" : { }, + "eu-west-2" : { }, + "us-east-1" : { }, + "us-west-2" : { } + } + }, "waf" : { "endpoints" : { + "aws" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "variants" : [ { + "hostname" : "waf-fips.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "aws-fips" : { "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "waf-fips.amazonaws.com" }, "aws-global" : { "credentialScope" : { "region" : "us-east-1" }, - "hostname" : "waf.amazonaws.com" + "hostname" : "waf.amazonaws.com", + "variants" : [ { + "hostname" : "waf-fips.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "aws-global-fips" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "waf-fips.amazonaws.com" } }, "isRegionalized" : false, @@ -6193,244 +12409,371 @@ "credentialScope" : { "region" : "af-south-1" }, - "hostname" : "waf-regional.af-south-1.amazonaws.com" + "hostname" : "waf-regional.af-south-1.amazonaws.com", + "variants" : [ { + "hostname" : "waf-regional-fips.af-south-1.amazonaws.com", + "tags" : [ "fips" ] + } ] }, "ap-east-1" : { "credentialScope" : { "region" : "ap-east-1" }, - "hostname" : "waf-regional.ap-east-1.amazonaws.com" + "hostname" : "waf-regional.ap-east-1.amazonaws.com", + "variants" : [ { + "hostname" : "waf-regional-fips.ap-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] }, "ap-northeast-1" : { "credentialScope" : { "region" : "ap-northeast-1" }, - "hostname" : "waf-regional.ap-northeast-1.amazonaws.com" + "hostname" : "waf-regional.ap-northeast-1.amazonaws.com", + "variants" : [ { + "hostname" : "waf-regional-fips.ap-northeast-1.amazonaws.com", + "tags" : [ "fips" ] + } ] }, "ap-northeast-2" : { "credentialScope" : { "region" : "ap-northeast-2" }, - "hostname" : "waf-regional.ap-northeast-2.amazonaws.com" + "hostname" : "waf-regional.ap-northeast-2.amazonaws.com", + "variants" : [ { + "hostname" : "waf-regional-fips.ap-northeast-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "ap-northeast-3" : { + "credentialScope" : { + "region" : "ap-northeast-3" + }, + "hostname" : "waf-regional.ap-northeast-3.amazonaws.com", + "variants" : [ { + "hostname" : "waf-regional-fips.ap-northeast-3.amazonaws.com", + "tags" : [ "fips" ] + } ] }, "ap-south-1" : { "credentialScope" : { "region" : "ap-south-1" }, - "hostname" : "waf-regional.ap-south-1.amazonaws.com" + "hostname" : "waf-regional.ap-south-1.amazonaws.com", + "variants" : [ { + "hostname" : "waf-regional-fips.ap-south-1.amazonaws.com", + "tags" : [ "fips" ] + } ] }, "ap-southeast-1" : { "credentialScope" : { "region" : "ap-southeast-1" }, - "hostname" : "waf-regional.ap-southeast-1.amazonaws.com" + "hostname" : "waf-regional.ap-southeast-1.amazonaws.com", + "variants" : [ { + "hostname" : "waf-regional-fips.ap-southeast-1.amazonaws.com", + "tags" : [ "fips" ] + } ] }, "ap-southeast-2" : { "credentialScope" : { "region" : "ap-southeast-2" }, - "hostname" : "waf-regional.ap-southeast-2.amazonaws.com" + "hostname" : "waf-regional.ap-southeast-2.amazonaws.com", + "variants" : [ { + "hostname" : "waf-regional-fips.ap-southeast-2.amazonaws.com", + "tags" : [ "fips" ] + } ] }, "ca-central-1" : { "credentialScope" : { "region" : "ca-central-1" }, - "hostname" : "waf-regional.ca-central-1.amazonaws.com" + "hostname" : "waf-regional.ca-central-1.amazonaws.com", + "variants" : [ { + "hostname" : "waf-regional-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] }, "eu-central-1" : { "credentialScope" : { "region" : "eu-central-1" }, - "hostname" : "waf-regional.eu-central-1.amazonaws.com" + "hostname" : "waf-regional.eu-central-1.amazonaws.com", + "variants" : [ { + "hostname" : "waf-regional-fips.eu-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] }, "eu-north-1" : { "credentialScope" : { "region" : "eu-north-1" }, - "hostname" : "waf-regional.eu-north-1.amazonaws.com" + "hostname" : "waf-regional.eu-north-1.amazonaws.com", + "variants" : [ { + "hostname" : "waf-regional-fips.eu-north-1.amazonaws.com", + "tags" : [ "fips" ] + } ] }, "eu-south-1" : { "credentialScope" : { "region" : "eu-south-1" }, - "hostname" : "waf-regional.eu-south-1.amazonaws.com" + "hostname" : "waf-regional.eu-south-1.amazonaws.com", + "variants" : [ { + "hostname" : "waf-regional-fips.eu-south-1.amazonaws.com", + "tags" : [ "fips" ] + } ] }, "eu-west-1" : { "credentialScope" : { "region" : "eu-west-1" }, - "hostname" : "waf-regional.eu-west-1.amazonaws.com" + "hostname" : "waf-regional.eu-west-1.amazonaws.com", + "variants" : [ { + "hostname" : "waf-regional-fips.eu-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] }, "eu-west-2" : { "credentialScope" : { "region" : "eu-west-2" }, - "hostname" : "waf-regional.eu-west-2.amazonaws.com" + "hostname" : "waf-regional.eu-west-2.amazonaws.com", + "variants" : [ { + "hostname" : "waf-regional-fips.eu-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] }, "eu-west-3" : { "credentialScope" : { "region" : "eu-west-3" }, - "hostname" : "waf-regional.eu-west-3.amazonaws.com" + "hostname" : "waf-regional.eu-west-3.amazonaws.com", + "variants" : [ { + "hostname" : "waf-regional-fips.eu-west-3.amazonaws.com", + "tags" : [ "fips" ] + } ] }, "fips-af-south-1" : { "credentialScope" : { "region" : "af-south-1" }, + "deprecated" : true, "hostname" : "waf-regional-fips.af-south-1.amazonaws.com" }, "fips-ap-east-1" : { "credentialScope" : { "region" : "ap-east-1" }, + "deprecated" : true, "hostname" : "waf-regional-fips.ap-east-1.amazonaws.com" }, "fips-ap-northeast-1" : { "credentialScope" : { "region" : "ap-northeast-1" }, + "deprecated" : true, "hostname" : "waf-regional-fips.ap-northeast-1.amazonaws.com" }, "fips-ap-northeast-2" : { "credentialScope" : { "region" : "ap-northeast-2" }, + "deprecated" : true, "hostname" : "waf-regional-fips.ap-northeast-2.amazonaws.com" }, + "fips-ap-northeast-3" : { + "credentialScope" : { + "region" : "ap-northeast-3" + }, + "deprecated" : true, + "hostname" : "waf-regional-fips.ap-northeast-3.amazonaws.com" + }, "fips-ap-south-1" : { "credentialScope" : { "region" : "ap-south-1" }, + "deprecated" : true, "hostname" : "waf-regional-fips.ap-south-1.amazonaws.com" }, "fips-ap-southeast-1" : { "credentialScope" : { "region" : "ap-southeast-1" }, + "deprecated" : true, "hostname" : "waf-regional-fips.ap-southeast-1.amazonaws.com" }, "fips-ap-southeast-2" : { "credentialScope" : { "region" : "ap-southeast-2" }, + "deprecated" : true, "hostname" : "waf-regional-fips.ap-southeast-2.amazonaws.com" }, "fips-ca-central-1" : { "credentialScope" : { "region" : "ca-central-1" }, + "deprecated" : true, "hostname" : "waf-regional-fips.ca-central-1.amazonaws.com" }, "fips-eu-central-1" : { "credentialScope" : { "region" : "eu-central-1" }, + "deprecated" : true, "hostname" : "waf-regional-fips.eu-central-1.amazonaws.com" }, "fips-eu-north-1" : { "credentialScope" : { "region" : "eu-north-1" }, + "deprecated" : true, "hostname" : "waf-regional-fips.eu-north-1.amazonaws.com" }, "fips-eu-south-1" : { "credentialScope" : { "region" : "eu-south-1" }, + "deprecated" : true, "hostname" : "waf-regional-fips.eu-south-1.amazonaws.com" }, "fips-eu-west-1" : { "credentialScope" : { "region" : "eu-west-1" }, + "deprecated" : true, "hostname" : "waf-regional-fips.eu-west-1.amazonaws.com" }, "fips-eu-west-2" : { "credentialScope" : { "region" : "eu-west-2" }, + "deprecated" : true, "hostname" : "waf-regional-fips.eu-west-2.amazonaws.com" }, "fips-eu-west-3" : { "credentialScope" : { "region" : "eu-west-3" }, + "deprecated" : true, "hostname" : "waf-regional-fips.eu-west-3.amazonaws.com" }, "fips-me-south-1" : { "credentialScope" : { "region" : "me-south-1" }, + "deprecated" : true, "hostname" : "waf-regional-fips.me-south-1.amazonaws.com" }, "fips-sa-east-1" : { "credentialScope" : { "region" : "sa-east-1" }, + "deprecated" : true, "hostname" : "waf-regional-fips.sa-east-1.amazonaws.com" }, "fips-us-east-1" : { "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "waf-regional-fips.us-east-1.amazonaws.com" }, "fips-us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, + "deprecated" : true, "hostname" : "waf-regional-fips.us-east-2.amazonaws.com" }, "fips-us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, + "deprecated" : true, "hostname" : "waf-regional-fips.us-west-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "waf-regional-fips.us-west-2.amazonaws.com" }, "me-south-1" : { "credentialScope" : { "region" : "me-south-1" }, - "hostname" : "waf-regional.me-south-1.amazonaws.com" + "hostname" : "waf-regional.me-south-1.amazonaws.com", + "variants" : [ { + "hostname" : "waf-regional-fips.me-south-1.amazonaws.com", + "tags" : [ "fips" ] + } ] }, "sa-east-1" : { "credentialScope" : { "region" : "sa-east-1" }, - "hostname" : "waf-regional.sa-east-1.amazonaws.com" + "hostname" : "waf-regional.sa-east-1.amazonaws.com", + "variants" : [ { + "hostname" : "waf-regional-fips.sa-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] }, "us-east-1" : { "credentialScope" : { "region" : "us-east-1" }, - "hostname" : "waf-regional.us-east-1.amazonaws.com" + "hostname" : "waf-regional.us-east-1.amazonaws.com", + "variants" : [ { + "hostname" : "waf-regional-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] }, "us-east-2" : { "credentialScope" : { "region" : "us-east-2" }, - "hostname" : "waf-regional.us-east-2.amazonaws.com" + "hostname" : "waf-regional.us-east-2.amazonaws.com", + "variants" : [ { + "hostname" : "waf-regional-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] }, "us-west-1" : { "credentialScope" : { "region" : "us-west-1" }, - "hostname" : "waf-regional.us-west-1.amazonaws.com" + "hostname" : "waf-regional.us-west-1.amazonaws.com", + "variants" : [ { + "hostname" : "waf-regional-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] }, "us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, - "hostname" : "waf-regional.us-west-2.amazonaws.com" + "hostname" : "waf-regional.us-west-2.amazonaws.com", + "variants" : [ { + "hostname" : "waf-regional-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] } } }, + "wisdom" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-southeast-2" : { }, + "eu-central-1" : { }, + "eu-west-2" : { }, + "us-east-1" : { }, + "us-west-2" : { } + } + }, "workdocs" : { "endpoints" : { "ap-northeast-1" : { }, @@ -6441,16 +12784,28 @@ "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "workdocs-fips.us-east-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "workdocs-fips.us-west-2.amazonaws.com" }, - "us-east-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "workdocs-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "workdocs-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "workmail" : { @@ -6467,6 +12822,7 @@ "endpoints" : { "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, "ca-central-1" : { }, @@ -6477,15 +12833,34 @@ "credentialScope" : { "region" : "us-east-1" }, + "deprecated" : true, "hostname" : "workspaces-fips.us-east-1.amazonaws.com" }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" }, + "deprecated" : true, "hostname" : "workspaces-fips.us-west-2.amazonaws.com" }, "sa-east-1" : { }, + "us-east-1" : { + "variants" : [ { + "hostname" : "workspaces-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "workspaces-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, + "workspaces-web" : { + "endpoints" : { + "eu-west-1" : { }, "us-east-1" : { }, "us-west-2" : { } } @@ -6496,9 +12871,11 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-3" : { }, "ca-central-1" : { }, "eu-central-1" : { }, "eu-north-1" : { }, @@ -6506,12 +12883,60 @@ "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "xray-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "hostname" : "xray-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "deprecated" : true, + "hostname" : "xray-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "hostname" : "xray-fips.us-west-2.amazonaws.com" + }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "xray-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "xray-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "xray-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "xray-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } } } @@ -6519,7 +12944,20 @@ "defaults" : { "hostname" : "{service}.{region}.{dnsSuffix}", "protocols" : [ "https" ], - "signatureVersions" : [ "v4" ] + "signatureVersions" : [ "v4" ], + "variants" : [ { + "dnsSuffix" : "amazonaws.com.cn", + "hostname" : "{service}-fips.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + }, { + "dnsSuffix" : "api.amazonwebservices.com.cn", + "hostname" : "{service}-fips.{region}.{dnsSuffix}", + "tags" : [ "dualstack", "fips" ] + }, { + "dnsSuffix" : "api.amazonwebservices.com.cn", + "hostname" : "{service}.{region}.{dnsSuffix}", + "tags" : [ "dualstack" ] + } ] }, "dnsSuffix" : "amazonaws.com.cn", "partition" : "aws-cn", @@ -6540,6 +12978,18 @@ "cn-northwest-1" : { } } }, + "account" : { + "endpoints" : { + "aws-cn-global" : { + "credentialScope" : { + "region" : "cn-northwest-1" + }, + "hostname" : "account.cn-northwest-1.amazonaws.com.cn" + } + }, + "isRegionalized" : false, + "partitionEndpoint" : "aws-cn-global" + }, "acm" : { "endpoints" : { "cn-north-1" : { }, @@ -6568,12 +13018,24 @@ "cn-northwest-1" : { } } }, + "api.tunneling.iot" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, "apigateway" : { "endpoints" : { "cn-north-1" : { }, "cn-northwest-1" : { } } }, + "appconfigdata" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, "application-autoscaling" : { "defaults" : { "protocols" : [ "http", "https" ] @@ -6583,6 +13045,18 @@ "cn-northwest-1" : { } } }, + "applicationinsights" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "appmesh" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, "appsync" : { "endpoints" : { "cn-north-1" : { }, @@ -6692,11 +13166,33 @@ "cn-northwest-1" : { } } }, + "codepipeline" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, "cognito-identity" : { "endpoints" : { "cn-north-1" : { } } }, + "compute-optimizer" : { + "endpoints" : { + "cn-north-1" : { + "credentialScope" : { + "region" : "cn-north-1" + }, + "hostname" : "compute-optimizer.cn-north-1.amazonaws.com.cn" + }, + "cn-northwest-1" : { + "credentialScope" : { + "region" : "cn-northwest-1" + }, + "hostname" : "compute-optimizer.cn-northwest-1.amazonaws.com.cn" + } + } + }, "config" : { "endpoints" : { "cn-north-1" : { }, @@ -6720,8 +13216,21 @@ "cn-northwest-1" : { } } }, + "data.jobs.iot" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "databrew" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, "dax" : { "endpoints" : { + "cn-north-1" : { }, "cn-northwest-1" : { } } }, @@ -6806,18 +13315,30 @@ }, "elasticfilesystem" : { "endpoints" : { - "cn-north-1" : { }, - "cn-northwest-1" : { }, + "cn-north-1" : { + "variants" : [ { + "hostname" : "elasticfilesystem-fips.cn-north-1.amazonaws.com.cn", + "tags" : [ "fips" ] + } ] + }, + "cn-northwest-1" : { + "variants" : [ { + "hostname" : "elasticfilesystem-fips.cn-northwest-1.amazonaws.com.cn", + "tags" : [ "fips" ] + } ] + }, "fips-cn-north-1" : { "credentialScope" : { "region" : "cn-north-1" }, + "deprecated" : true, "hostname" : "elasticfilesystem-fips.cn-north-1.amazonaws.com.cn" }, "fips-cn-northwest-1" : { "credentialScope" : { "region" : "cn-northwest-1" }, + "deprecated" : true, "hostname" : "elasticfilesystem-fips.cn-northwest-1.amazonaws.com.cn" } } @@ -6840,6 +13361,12 @@ "cn-northwest-1" : { } } }, + "emr-containers" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, "es" : { "endpoints" : { "cn-north-1" : { }, @@ -6858,6 +13385,15 @@ "cn-northwest-1" : { } } }, + "fms" : { + "defaults" : { + "protocols" : [ "https" ] + }, + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, "fsx" : { "endpoints" : { "cn-north-1" : { }, @@ -6866,7 +13402,8 @@ }, "gamelift" : { "endpoints" : { - "cn-north-1" : { } + "cn-north-1" : { }, + "cn-northwest-1" : { } } }, "glacier" : { @@ -6884,12 +13421,22 @@ "cn-northwest-1" : { } } }, - "greengrass" : { + "greengrass" : { + "defaults" : { + "protocols" : [ "https" ] + }, + "endpoints" : { + "cn-north-1" : { } + }, + "isRegionalized" : true + }, + "guardduty" : { "defaults" : { "protocols" : [ "https" ] }, "endpoints" : { - "cn-north-1" : { } + "cn-north-1" : { }, + "cn-northwest-1" : { } }, "isRegionalized" : true }, @@ -6948,6 +13495,11 @@ "cn-northwest-1" : { } } }, + "iotsitewise" : { + "endpoints" : { + "cn-north-1" : { } + } + }, "kafka" : { "endpoints" : { "cn-north-1" : { }, @@ -6974,13 +13526,24 @@ }, "lakeformation" : { "endpoints" : { - "cn-north-1" : { } + "cn-north-1" : { }, + "cn-northwest-1" : { } } }, "lambda" : { "endpoints" : { - "cn-north-1" : { }, - "cn-northwest-1" : { } + "cn-north-1" : { + "variants" : [ { + "hostname" : "lambda.cn-north-1.api.amazonwebservices.com.cn", + "tags" : [ "dualstack" ] + } ] + }, + "cn-northwest-1" : { + "variants" : [ { + "hostname" : "lambda.cn-northwest-1.api.amazonwebservices.com.cn", + "tags" : [ "dualstack" ] + } ] + } } }, "license-manager" : { @@ -7014,8 +13577,20 @@ "cn-northwest-1" : { } } }, + "mq" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, "neptune" : { "endpoints" : { + "cn-north-1" : { + "credentialScope" : { + "region" : "cn-north-1" + }, + "hostname" : "rds.cn-north-1.amazonaws.com.cn" + }, "cn-northwest-1" : { "credentialScope" : { "region" : "cn-northwest-1" @@ -7031,17 +13606,22 @@ "region" : "cn-northwest-1" }, "hostname" : "organizations.cn-northwest-1.amazonaws.com.cn" - }, - "fips-aws-cn-global" : { - "credentialScope" : { - "region" : "cn-northwest-1" - }, - "hostname" : "organizations.cn-northwest-1.amazonaws.com.cn" } }, "isRegionalized" : false, "partitionEndpoint" : "aws-cn-global" }, + "personalize" : { + "endpoints" : { + "cn-north-1" : { } + } + }, + "pi" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, "polly" : { "endpoints" : { "cn-northwest-1" : { } @@ -7083,6 +13663,15 @@ "isRegionalized" : false, "partitionEndpoint" : "aws-cn-global" }, + "route53resolver" : { + "defaults" : { + "protocols" : [ "https" ] + }, + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, "runtime.sagemaker" : { "endpoints" : { "cn-north-1" : { }, @@ -7092,17 +13681,37 @@ "s3" : { "defaults" : { "protocols" : [ "http", "https" ], - "signatureVersions" : [ "s3v4" ] + "signatureVersions" : [ "s3v4" ], + "variants" : [ { + "dnsSuffix" : "amazonaws.com.cn", + "hostname" : "{service}.dualstack.{region}.{dnsSuffix}", + "tags" : [ "dualstack" ] + } ] }, "endpoints" : { - "cn-north-1" : { }, - "cn-northwest-1" : { } + "cn-north-1" : { + "variants" : [ { + "hostname" : "s3.dualstack.cn-north-1.amazonaws.com.cn", + "tags" : [ "dualstack" ] + } ] + }, + "cn-northwest-1" : { + "variants" : [ { + "hostname" : "s3.dualstack.cn-northwest-1.amazonaws.com.cn", + "tags" : [ "dualstack" ] + } ] + } } }, "s3-control" : { "defaults" : { "protocols" : [ "https" ], - "signatureVersions" : [ "s3v4" ] + "signatureVersions" : [ "s3v4" ], + "variants" : [ { + "dnsSuffix" : "amazonaws.com.cn", + "hostname" : "{service}.dualstack.{region}.{dnsSuffix}", + "tags" : [ "dualstack" ] + } ] }, "endpoints" : { "cn-north-1" : { @@ -7110,14 +13719,22 @@ "region" : "cn-north-1" }, "hostname" : "s3-control.cn-north-1.amazonaws.com.cn", - "signatureVersions" : [ "s3v4" ] + "signatureVersions" : [ "s3v4" ], + "variants" : [ { + "hostname" : "s3-control.dualstack.cn-north-1.amazonaws.com.cn", + "tags" : [ "dualstack" ] + } ] }, "cn-northwest-1" : { "credentialScope" : { "region" : "cn-northwest-1" }, "hostname" : "s3-control.cn-northwest-1.amazonaws.com.cn", - "signatureVersions" : [ "s3v4" ] + "signatureVersions" : [ "s3v4" ], + "variants" : [ { + "hostname" : "s3-control.dualstack.cn-northwest-1.amazonaws.com.cn", + "tags" : [ "dualstack" ] + } ] } } }, @@ -7146,6 +13763,12 @@ } } }, + "servicecatalog" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, "servicediscovery" : { "endpoints" : { "cn-north-1" : { }, @@ -7160,18 +13783,30 @@ }, "snowball" : { "endpoints" : { - "cn-north-1" : { }, - "cn-northwest-1" : { }, + "cn-north-1" : { + "variants" : [ { + "hostname" : "snowball-fips.cn-north-1.amazonaws.com.cn", + "tags" : [ "fips" ] + } ] + }, + "cn-northwest-1" : { + "variants" : [ { + "hostname" : "snowball-fips.cn-northwest-1.amazonaws.com.cn", + "tags" : [ "fips" ] + } ] + }, "fips-cn-north-1" : { "credentialScope" : { "region" : "cn-north-1" }, + "deprecated" : true, "hostname" : "snowball-fips.cn-north-1.amazonaws.com.cn" }, "fips-cn-northwest-1" : { "credentialScope" : { "region" : "cn-northwest-1" }, + "deprecated" : true, "hostname" : "snowball-fips.cn-northwest-1.amazonaws.com.cn" } } @@ -7248,6 +13883,12 @@ "cn-northwest-1" : { } } }, + "synthetics" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, "tagging" : { "endpoints" : { "cn-north-1" : { }, @@ -7273,6 +13914,56 @@ } } }, + "transcribestreaming" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "transfer" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "waf-regional" : { + "endpoints" : { + "cn-north-1" : { + "credentialScope" : { + "region" : "cn-north-1" + }, + "hostname" : "waf-regional.cn-north-1.amazonaws.com.cn", + "variants" : [ { + "hostname" : "waf-regional-fips.cn-north-1.amazonaws.com.cn", + "tags" : [ "fips" ] + } ] + }, + "cn-northwest-1" : { + "credentialScope" : { + "region" : "cn-northwest-1" + }, + "hostname" : "waf-regional.cn-northwest-1.amazonaws.com.cn", + "variants" : [ { + "hostname" : "waf-regional-fips.cn-northwest-1.amazonaws.com.cn", + "tags" : [ "fips" ] + } ] + }, + "fips-cn-north-1" : { + "credentialScope" : { + "region" : "cn-north-1" + }, + "deprecated" : true, + "hostname" : "waf-regional-fips.cn-north-1.amazonaws.com.cn" + }, + "fips-cn-northwest-1" : { + "credentialScope" : { + "region" : "cn-northwest-1" + }, + "deprecated" : true, + "hostname" : "waf-regional-fips.cn-northwest-1.amazonaws.com.cn" + } + } + }, "workspaces" : { "endpoints" : { "cn-northwest-1" : { } @@ -7289,7 +13980,20 @@ "defaults" : { "hostname" : "{service}.{region}.{dnsSuffix}", "protocols" : [ "https" ], - "signatureVersions" : [ "v4" ] + "signatureVersions" : [ "v4" ], + "variants" : [ { + "dnsSuffix" : "amazonaws.com", + "hostname" : "{service}-fips.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + }, { + "dnsSuffix" : "api.aws", + "hostname" : "{service}-fips.{region}.{dnsSuffix}", + "tags" : [ "dualstack", "fips" ] + }, { + "dnsSuffix" : "api.aws", + "hostname" : "{service}.{region}.{dnsSuffix}", + "tags" : [ "dualstack" ] + } ] }, "dnsSuffix" : "amazonaws.com", "partition" : "aws-us-gov", @@ -7321,6 +14025,12 @@ } }, "acm" : { + "defaults" : { + "variants" : [ { + "hostname" : "acm.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] + }, "endpoints" : { "us-gov-east-1" : { "credentialScope" : { @@ -7338,79 +14048,225 @@ }, "acm-pca" : { "defaults" : { - "protocols" : [ "https" ] + "protocols" : [ "https" ], + "variants" : [ { + "hostname" : "acm-pca.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] }, "endpoints" : { "fips-us-gov-east-1" : { "credentialScope" : { "region" : "us-gov-east-1" }, + "deprecated" : true, "hostname" : "acm-pca.us-gov-east-1.amazonaws.com" }, "fips-us-gov-west-1" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "acm-pca.us-gov-west-1.amazonaws.com" }, - "us-gov-east-1" : { }, - "us-gov-west-1" : { } + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "acm-pca.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "acm-pca.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, + "api.detective" : { + "defaults" : { + "protocols" : [ "https" ] + }, + "endpoints" : { + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "api.detective-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-east-1-fips" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "deprecated" : true, + "hostname" : "api.detective-fips.us-gov-east-1.amazonaws.com" + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "api.detective-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1-fips" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "hostname" : "api.detective-fips.us-gov-west-1.amazonaws.com" + } } }, "api.ecr" : { + "defaults" : { + "variants" : [ { + "hostname" : "ecr-fips.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] + }, "endpoints" : { + "dkr-us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "deprecated" : true, + "variants" : [ { + "hostname" : "ecr-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "dkr-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "variants" : [ { + "hostname" : "ecr-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "fips-dkr-us-gov-east-1" : { "credentialScope" : { "region" : "us-gov-east-1" }, + "deprecated" : true, "hostname" : "ecr-fips.us-gov-east-1.amazonaws.com" }, "fips-dkr-us-gov-west-1" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "ecr-fips.us-gov-west-1.amazonaws.com" }, "fips-us-gov-east-1" : { "credentialScope" : { "region" : "us-gov-east-1" }, + "deprecated" : true, "hostname" : "ecr-fips.us-gov-east-1.amazonaws.com" }, "fips-us-gov-west-1" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "ecr-fips.us-gov-west-1.amazonaws.com" }, "us-gov-east-1" : { "credentialScope" : { "region" : "us-gov-east-1" }, - "hostname" : "api.ecr.us-gov-east-1.amazonaws.com" + "hostname" : "api.ecr.us-gov-east-1.amazonaws.com", + "variants" : [ { + "hostname" : "ecr-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] }, "us-gov-west-1" : { "credentialScope" : { "region" : "us-gov-west-1" }, - "hostname" : "api.ecr.us-gov-west-1.amazonaws.com" + "hostname" : "api.ecr.us-gov-west-1.amazonaws.com", + "variants" : [ { + "hostname" : "ecr-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] } } }, "api.sagemaker" : { + "defaults" : { + "variants" : [ { + "hostname" : "api-fips.sagemaker.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] + }, "endpoints" : { - "us-gov-west-1" : { }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "api-fips.sagemaker.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-gov-west-1-fips" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "api-fips.sagemaker.us-gov-west-1.amazonaws.com" }, "us-gov-west-1-fips-secondary" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "api.sagemaker.us-gov-west-1.amazonaws.com" + }, + "us-gov-west-1-secondary" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "variants" : [ { + "hostname" : "api.sagemaker.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, + "api.tunneling.iot" : { + "defaults" : { + "variants" : [ { + "hostname" : "api.tunneling.iot-fips.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] + }, + "endpoints" : { + "fips-us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "deprecated" : true, + "hostname" : "api.tunneling.iot-fips.us-gov-east-1.amazonaws.com" + }, + "fips-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "hostname" : "api.tunneling.iot-fips.us-gov-west-1.amazonaws.com" + }, + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "api.tunneling.iot-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "api.tunneling.iot-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] } } }, @@ -7420,6 +14276,12 @@ "us-gov-west-1" : { } } }, + "appconfigdata" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, "application-autoscaling" : { "defaults" : { "protocols" : [ "http", "https" ] @@ -7433,6 +14295,22 @@ } } }, + "applicationinsights" : { + "endpoints" : { + "us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "hostname" : "applicationinsights.us-gov-east-1.amazonaws.com" + }, + "us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "applicationinsights.us-gov-west-1.amazonaws.com" + } + } + }, "appstream2" : { "defaults" : { "credentialScope" : { @@ -7445,9 +14323,22 @@ "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "appstream2-fips.us-gov-west-1.amazonaws.com" }, - "us-gov-west-1" : { } + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "appstream2-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1-fips" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "hostname" : "appstream2-fips.us-gov-west-1.amazonaws.com" + } } }, "athena" : { @@ -7456,19 +14347,37 @@ "credentialScope" : { "region" : "us-gov-east-1" }, + "deprecated" : true, "hostname" : "athena-fips.us-gov-east-1.amazonaws.com" }, "fips-us-gov-west-1" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "athena-fips.us-gov-west-1.amazonaws.com" }, - "us-gov-east-1" : { }, - "us-gov-west-1" : { } + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "athena-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "athena-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "autoscaling" : { + "defaults" : { + "variants" : [ { + "hostname" : "autoscaling.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] + }, "endpoints" : { "us-gov-east-1" : { "protocols" : [ "http", "https" ] @@ -7498,21 +14407,69 @@ } }, "batch" : { + "defaults" : { + "variants" : [ { + "hostname" : "batch.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] + }, "endpoints" : { "fips-us-gov-east-1" : { "credentialScope" : { "region" : "us-gov-east-1" }, + "deprecated" : true, "hostname" : "batch.us-gov-east-1.amazonaws.com" }, "fips-us-gov-west-1" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "batch.us-gov-west-1.amazonaws.com" }, - "us-gov-east-1" : { }, - "us-gov-west-1" : { } + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "batch.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "batch.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, + "cloudcontrolapi" : { + "endpoints" : { + "fips-us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "deprecated" : true, + "hostname" : "cloudcontrolapi-fips.us-gov-east-1.amazonaws.com" + }, + "fips-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "hostname" : "cloudcontrolapi-fips.us-gov-west-1.amazonaws.com" + }, + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "cloudcontrolapi-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "cloudcontrolapi-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "clouddirectory" : { @@ -7554,34 +14511,60 @@ }, "cloudtrail" : { "endpoints" : { - "us-gov-east-1" : { + "fips-us-gov-east-1" : { "credentialScope" : { "region" : "us-gov-east-1" }, + "deprecated" : true, "hostname" : "cloudtrail.us-gov-east-1.amazonaws.com" }, - "us-gov-west-1" : { + "fips-us-gov-west-1" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "cloudtrail.us-gov-west-1.amazonaws.com" + }, + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "cloudtrail.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "cloudtrail.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] } } }, "codebuild" : { "endpoints" : { - "us-gov-east-1" : { }, + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "codebuild-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-gov-east-1-fips" : { "credentialScope" : { "region" : "us-gov-east-1" }, + "deprecated" : true, "hostname" : "codebuild-fips.us-gov-east-1.amazonaws.com" }, - "us-gov-west-1" : { }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "codebuild-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-gov-west-1-fips" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "codebuild-fips.us-gov-west-1.amazonaws.com" } } @@ -7592,26 +14575,63 @@ "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "codecommit-fips.us-gov-west-1.amazonaws.com" }, - "us-gov-east-1" : { }, - "us-gov-west-1" : { } + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "codecommit-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-east-1-fips" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "deprecated" : true, + "hostname" : "codecommit-fips.us-gov-east-1.amazonaws.com" + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "codecommit-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1-fips" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "hostname" : "codecommit-fips.us-gov-west-1.amazonaws.com" + } } }, "codedeploy" : { "endpoints" : { - "us-gov-east-1" : { }, + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "codedeploy-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-gov-east-1-fips" : { "credentialScope" : { "region" : "us-gov-east-1" }, + "deprecated" : true, "hostname" : "codedeploy-fips.us-gov-east-1.amazonaws.com" }, - "us-gov-west-1" : { }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "codedeploy-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-gov-west-1-fips" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "codedeploy-fips.us-gov-west-1.amazonaws.com" } } @@ -7622,9 +14642,15 @@ "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "codepipeline-fips.us-gov-west-1.amazonaws.com" }, - "us-gov-west-1" : { } + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "codepipeline-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "cognito-identity" : { @@ -7633,9 +14659,15 @@ "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "cognito-identity-fips.us-gov-west-1.amazonaws.com" }, - "us-gov-west-1" : { } + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "cognito-identity-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "cognito-idp" : { @@ -7644,9 +14676,15 @@ "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "cognito-idp-fips.us-gov-west-1.amazonaws.com" }, - "us-gov-west-1" : { } + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "cognito-idp-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "comprehend" : { @@ -7658,9 +14696,15 @@ "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "comprehend-fips.us-gov-west-1.amazonaws.com" }, - "us-gov-west-1" : { } + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "comprehend-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "comprehendmedical" : { @@ -7669,26 +14713,55 @@ "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "comprehendmedical-fips.us-gov-west-1.amazonaws.com" }, - "us-gov-west-1" : { } + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "comprehendmedical-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "config" : { + "defaults" : { + "variants" : [ { + "hostname" : "config.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] + }, "endpoints" : { "fips-us-gov-east-1" : { "credentialScope" : { "region" : "us-gov-east-1" }, + "deprecated" : true, "hostname" : "config.us-gov-east-1.amazonaws.com" }, "fips-us-gov-west-1" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "config.us-gov-west-1.amazonaws.com" }, - "us-gov-east-1" : { }, + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "config.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "config.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, + "connect" : { + "endpoints" : { "us-gov-west-1" : { } } }, @@ -7700,7 +14773,66 @@ "protocols" : [ "https" ] }, "endpoints" : { - "us-gov-east-1" : { }, + "fips-us-gov-east-1" : { + "credentialScope" : { + "service" : "iotdata" + }, + "deprecated" : true, + "hostname" : "data.iot-fips.us-gov-east-1.amazonaws.com" + }, + "fips-us-gov-west-1" : { + "credentialScope" : { + "service" : "iotdata" + }, + "deprecated" : true, + "hostname" : "data.iot-fips.us-gov-west-1.amazonaws.com" + }, + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "data.iot-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "data.iot-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, + "data.jobs.iot" : { + "endpoints" : { + "fips-us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "deprecated" : true, + "hostname" : "data.jobs.iot-fips.us-gov-east-1.amazonaws.com" + }, + "fips-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "hostname" : "data.jobs.iot-fips.us-gov-west-1.amazonaws.com" + }, + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "data.jobs.iot-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "data.jobs.iot-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, + "databrew" : { + "endpoints" : { "us-gov-west-1" : { } } }, @@ -7710,16 +14842,28 @@ "credentialScope" : { "region" : "us-gov-east-1" }, + "deprecated" : true, "hostname" : "datasync-fips.us-gov-east-1.amazonaws.com" }, "fips-us-gov-west-1" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "datasync-fips.us-gov-west-1.amazonaws.com" }, - "us-gov-east-1" : { }, - "us-gov-west-1" : { } + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "datasync-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "datasync-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "directconnect" : { @@ -7739,15 +14883,56 @@ } }, "dms" : { + "defaults" : { + "variants" : [ { + "hostname" : "dms.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] + }, "endpoints" : { + "dms" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "variants" : [ { + "hostname" : "dms.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "dms-fips" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "dms.us-gov-west-1.amazonaws.com" }, - "us-gov-east-1" : { }, - "us-gov-west-1" : { } + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "dms.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-east-1-fips" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "deprecated" : true, + "hostname" : "dms.us-gov-east-1.amazonaws.com" + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "dms.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1-fips" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "hostname" : "dms.us-gov-west-1.amazonaws.com" + } } }, "docdb" : { @@ -7766,32 +14951,62 @@ "credentialScope" : { "region" : "us-gov-east-1" }, + "deprecated" : true, "hostname" : "ds-fips.us-gov-east-1.amazonaws.com" }, "fips-us-gov-west-1" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "ds-fips.us-gov-west-1.amazonaws.com" }, - "us-gov-east-1" : { }, - "us-gov-west-1" : { } + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "ds-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "ds-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "dynamodb" : { + "defaults" : { + "variants" : [ { + "hostname" : "dynamodb.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] + }, "endpoints" : { - "us-gov-east-1" : { }, + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "dynamodb.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-gov-east-1-fips" : { "credentialScope" : { "region" : "us-gov-east-1" }, + "deprecated" : true, "hostname" : "dynamodb.us-gov-east-1.amazonaws.com" }, - "us-gov-west-1" : { }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "dynamodb.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-gov-west-1-fips" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "dynamodb.us-gov-west-1.amazonaws.com" } } @@ -7803,6 +15018,12 @@ } }, "ec2" : { + "defaults" : { + "variants" : [ { + "hostname" : "ec2.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] + }, "endpoints" : { "us-gov-east-1" : { "credentialScope" : { @@ -7824,49 +15045,96 @@ "credentialScope" : { "region" : "us-gov-east-1" }, + "deprecated" : true, "hostname" : "ecs-fips.us-gov-east-1.amazonaws.com" }, "fips-us-gov-west-1" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "ecs-fips.us-gov-west-1.amazonaws.com" }, - "us-gov-east-1" : { }, - "us-gov-west-1" : { } + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "ecs-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "ecs-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "eks" : { "defaults" : { - "protocols" : [ "http", "https" ] + "protocols" : [ "http", "https" ], + "variants" : [ { + "hostname" : "eks.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] }, "endpoints" : { "fips-us-gov-east-1" : { "credentialScope" : { "region" : "us-gov-east-1" }, + "deprecated" : true, "hostname" : "eks.us-gov-east-1.amazonaws.com" }, "fips-us-gov-west-1" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "eks.us-gov-west-1.amazonaws.com" }, - "us-gov-east-1" : { }, - "us-gov-west-1" : { } + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "eks.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "eks.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "elasticache" : { + "defaults" : { + "variants" : [ { + "hostname" : "elasticache.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] + }, "endpoints" : { "fips" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "elasticache.us-gov-west-1.amazonaws.com" }, "us-gov-east-1" : { }, - "us-gov-west-1" : { } + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "elasticache.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1-fips" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "hostname" : "elasticache.us-gov-west-1.amazonaws.com" + } } }, "elasticbeanstalk" : { @@ -7891,55 +15159,101 @@ "credentialScope" : { "region" : "us-gov-east-1" }, + "deprecated" : true, "hostname" : "elasticfilesystem-fips.us-gov-east-1.amazonaws.com" }, "fips-us-gov-west-1" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "elasticfilesystem-fips.us-gov-west-1.amazonaws.com" }, - "us-gov-east-1" : { }, - "us-gov-west-1" : { } + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "elasticfilesystem-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "elasticfilesystem-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "elasticloadbalancing" : { + "defaults" : { + "variants" : [ { + "hostname" : "elasticloadbalancing.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] + }, "endpoints" : { "fips-us-gov-east-1" : { "credentialScope" : { "region" : "us-gov-east-1" }, + "deprecated" : true, "hostname" : "elasticloadbalancing.us-gov-east-1.amazonaws.com" }, "fips-us-gov-west-1" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "elasticloadbalancing.us-gov-west-1.amazonaws.com" }, - "us-gov-east-1" : { }, + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "elasticloadbalancing.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-gov-west-1" : { - "protocols" : [ "http", "https" ] + "protocols" : [ "http", "https" ], + "variants" : [ { + "hostname" : "elasticloadbalancing.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] } } }, "elasticmapreduce" : { + "defaults" : { + "variants" : [ { + "hostname" : "elasticmapreduce.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] + }, "endpoints" : { "fips-us-gov-east-1" : { "credentialScope" : { "region" : "us-gov-east-1" }, + "deprecated" : true, "hostname" : "elasticmapreduce.us-gov-east-1.amazonaws.com" }, "fips-us-gov-west-1" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "elasticmapreduce.us-gov-west-1.amazonaws.com" }, - "us-gov-east-1" : { }, + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "elasticmapreduce.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-gov-west-1" : { - "protocols" : [ "https" ] + "protocols" : [ "https" ], + "variants" : [ { + "hostname" : "elasticmapreduce.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] } } }, @@ -7949,9 +15263,15 @@ "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "email-fips.us-gov-west-1.amazonaws.com" }, - "us-gov-west-1" : { } + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "email-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "es" : { @@ -7960,25 +15280,64 @@ "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "es-fips.us-gov-west-1.amazonaws.com" }, - "us-gov-east-1" : { }, - "us-gov-west-1" : { } + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "es-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-east-1-fips" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "deprecated" : true, + "hostname" : "es-fips.us-gov-east-1.amazonaws.com" + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "es-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1-fips" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "hostname" : "es-fips.us-gov-west-1.amazonaws.com" + } } }, "events" : { "endpoints" : { - "us-gov-east-1" : { + "fips-us-gov-east-1" : { "credentialScope" : { "region" : "us-gov-east-1" }, + "deprecated" : true, "hostname" : "events.us-gov-east-1.amazonaws.com" }, - "us-gov-west-1" : { + "fips-us-gov-west-1" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "events.us-gov-west-1.amazonaws.com" + }, + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "events.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "events.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] } } }, @@ -7988,16 +15347,125 @@ "credentialScope" : { "region" : "us-gov-east-1" }, + "deprecated" : true, "hostname" : "firehose-fips.us-gov-east-1.amazonaws.com" }, "fips-us-gov-west-1" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "firehose-fips.us-gov-west-1.amazonaws.com" }, - "us-gov-east-1" : { }, - "us-gov-west-1" : { } + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "firehose-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "firehose-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, + "fms" : { + "defaults" : { + "protocols" : [ "https" ] + }, + "endpoints" : { + "fips-us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "deprecated" : true, + "hostname" : "fms-fips.us-gov-east-1.amazonaws.com" + }, + "fips-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "hostname" : "fms-fips.us-gov-west-1.amazonaws.com" + }, + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "fms-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "fms-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, + "fsx" : { + "endpoints" : { + "fips-prod-us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "deprecated" : true, + "hostname" : "fsx-fips.us-gov-east-1.amazonaws.com" + }, + "fips-prod-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "hostname" : "fsx-fips.us-gov-west-1.amazonaws.com" + }, + "fips-us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "deprecated" : true, + "hostname" : "fsx-fips.us-gov-east-1.amazonaws.com" + }, + "fips-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "hostname" : "fsx-fips.us-gov-west-1.amazonaws.com" + }, + "prod-us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "deprecated" : true, + "variants" : [ { + "hostname" : "fsx-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "prod-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "variants" : [ { + "hostname" : "fsx-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "fsx-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "fsx-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "glacier" : { @@ -8023,16 +15491,28 @@ "credentialScope" : { "region" : "us-gov-east-1" }, + "deprecated" : true, "hostname" : "glue-fips.us-gov-east-1.amazonaws.com" }, "fips-us-gov-west-1" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "glue-fips.us-gov-west-1.amazonaws.com" }, - "us-gov-east-1" : { }, - "us-gov-west-1" : { } + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "glue-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "glue-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "greengrass" : { @@ -8056,9 +15536,19 @@ "credentialScope" : { "region" : "us-gov-east-1" }, + "deprecated" : true, "hostname" : "greengrass-fips.us-gov-east-1.amazonaws.com" }, - "us-gov-east-1" : { }, + "us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "hostname" : "greengrass.us-gov-east-1.amazonaws.com", + "variants" : [ { + "hostname" : "greengrass-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-gov-west-1" : { "credentialScope" : { "region" : "us-gov-west-1" @@ -8070,21 +15560,37 @@ }, "guardduty" : { "defaults" : { - "protocols" : [ "https" ] + "protocols" : [ "https" ], + "variants" : [ { + "hostname" : "guardduty.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] }, "endpoints" : { - "us-gov-east-1" : { }, + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "guardduty.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-gov-east-1-fips" : { "credentialScope" : { "region" : "us-gov-east-1" }, + "deprecated" : true, "hostname" : "guardduty.us-gov-east-1.amazonaws.com" }, - "us-gov-west-1" : { }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "guardduty.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-gov-west-1-fips" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "guardduty.us-gov-west-1.amazonaws.com" } }, @@ -8096,7 +15602,18 @@ "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "health-fips.us-gov-west-1.amazonaws.com" + }, + "us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "variants" : [ { + "hostname" : "health-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] } } }, @@ -8106,34 +15623,104 @@ "credentialScope" : { "region" : "us-gov-west-1" }, + "hostname" : "iam.us-gov.amazonaws.com", + "variants" : [ { + "hostname" : "iam.us-gov.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "aws-us-gov-global-fips" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, "hostname" : "iam.us-gov.amazonaws.com" }, + "iam-govcloud" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "variants" : [ { + "hostname" : "iam.us-gov.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "iam-govcloud-fips" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "iam.us-gov.amazonaws.com" } }, "isRegionalized" : false, "partitionEndpoint" : "aws-us-gov-global" }, + "identitystore" : { + "defaults" : { + "variants" : [ { + "hostname" : "identitystore.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] + }, + "endpoints" : { + "fips-us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "deprecated" : true, + "hostname" : "identitystore.us-gov-east-1.amazonaws.com" + }, + "fips-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "hostname" : "identitystore.us-gov-west-1.amazonaws.com" + }, + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "identitystore.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "identitystore.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, "inspector" : { "endpoints" : { "fips-us-gov-east-1" : { "credentialScope" : { "region" : "us-gov-east-1" }, + "deprecated" : true, "hostname" : "inspector-fips.us-gov-east-1.amazonaws.com" }, "fips-us-gov-west-1" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "inspector-fips.us-gov-west-1.amazonaws.com" }, - "us-gov-east-1" : { }, - "us-gov-west-1" : { } + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "inspector-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "inspector-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "iot" : { @@ -8143,13 +15730,87 @@ } }, "endpoints" : { - "us-gov-east-1" : { }, + "fips-us-gov-east-1" : { + "credentialScope" : { + "service" : "execute-api" + }, + "deprecated" : true, + "hostname" : "iot-fips.us-gov-east-1.amazonaws.com" + }, + "fips-us-gov-west-1" : { + "credentialScope" : { + "service" : "execute-api" + }, + "deprecated" : true, + "hostname" : "iot-fips.us-gov-west-1.amazonaws.com" + }, + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "iot-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "iot-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, + "iotevents" : { + "endpoints" : { "us-gov-west-1" : { } } }, + "ioteventsdata" : { + "endpoints" : { + "us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "data.iotevents.us-gov-west-1.amazonaws.com" + } + } + }, "iotsecuredtunneling" : { + "defaults" : { + "variants" : [ { + "hostname" : "api.tunneling.iot-fips.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] + }, + "endpoints" : { + "fips-us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "deprecated" : true, + "hostname" : "api.tunneling.iot-fips.us-gov-east-1.amazonaws.com" + }, + "fips-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "hostname" : "api.tunneling.iot-fips.us-gov-west-1.amazonaws.com" + }, + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "api.tunneling.iot-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "api.tunneling.iot-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, + "iotsitewise" : { "endpoints" : { - "us-gov-east-1" : { }, "us-gov-west-1" : { } } }, @@ -8159,6 +15820,23 @@ "us-gov-west-1" : { } } }, + "kendra" : { + "endpoints" : { + "fips-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "hostname" : "kendra-fips.us-gov-west-1.amazonaws.com" + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "kendra-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, "kinesis" : { "endpoints" : { "us-gov-east-1" : { @@ -8187,10 +15865,35 @@ "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "kms-fips.us-gov-west-1.amazonaws.com" }, - "us-gov-east-1" : { }, - "us-gov-west-1" : { } + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "kms-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-east-1-fips" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "deprecated" : true, + "hostname" : "kms-fips.us-gov-east-1.amazonaws.com" + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "kms-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1-fips" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "hostname" : "kms-fips.us-gov-west-1.amazonaws.com" + } } }, "lakeformation" : { @@ -8199,9 +15902,15 @@ "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "lakeformation-fips.us-gov-west-1.amazonaws.com" }, - "us-gov-west-1" : { } + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "lakeformation-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "lambda" : { @@ -8210,16 +15919,28 @@ "credentialScope" : { "region" : "us-gov-east-1" }, + "deprecated" : true, "hostname" : "lambda-fips.us-gov-east-1.amazonaws.com" }, "fips-us-gov-west-1" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "lambda-fips.us-gov-west-1.amazonaws.com" }, - "us-gov-east-1" : { }, - "us-gov-west-1" : { } + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "lambda-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "lambda-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "license-manager" : { @@ -8228,31 +15949,57 @@ "credentialScope" : { "region" : "us-gov-east-1" }, + "deprecated" : true, "hostname" : "license-manager-fips.us-gov-east-1.amazonaws.com" }, "fips-us-gov-west-1" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "license-manager-fips.us-gov-west-1.amazonaws.com" }, - "us-gov-east-1" : { }, - "us-gov-west-1" : { } + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "license-manager-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "license-manager-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "logs" : { "endpoints" : { - "us-gov-east-1" : { + "fips-us-gov-east-1" : { "credentialScope" : { "region" : "us-gov-east-1" }, + "deprecated" : true, "hostname" : "logs.us-gov-east-1.amazonaws.com" }, - "us-gov-west-1" : { + "fips-us-gov-west-1" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "logs.us-gov-west-1.amazonaws.com" + }, + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "logs.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "logs.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] } } }, @@ -8277,22 +16024,96 @@ "us-gov-west-1" : { } } }, + "models.lex" : { + "defaults" : { + "credentialScope" : { + "service" : "lex" + }, + "variants" : [ { + "hostname" : "models-fips.lex.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] + }, + "endpoints" : { + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "models-fips.lex.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1-fips" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "hostname" : "models-fips.lex.us-gov-west-1.amazonaws.com" + } + } + }, "monitoring" : { + "defaults" : { + "variants" : [ { + "hostname" : "monitoring.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] + }, "endpoints" : { "fips-us-gov-east-1" : { "credentialScope" : { "region" : "us-gov-east-1" }, + "deprecated" : true, "hostname" : "monitoring.us-gov-east-1.amazonaws.com" }, "fips-us-gov-west-1" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "monitoring.us-gov-west-1.amazonaws.com" }, - "us-gov-east-1" : { }, - "us-gov-west-1" : { } + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "monitoring.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "monitoring.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, + "mq" : { + "endpoints" : { + "fips-us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "deprecated" : true, + "hostname" : "mq-fips.us-gov-east-1.amazonaws.com" + }, + "fips-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "hostname" : "mq-fips.us-gov-west-1.amazonaws.com" + }, + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "mq-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "mq-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "neptune" : { @@ -8311,18 +16132,81 @@ } } }, + "network-firewall" : { + "endpoints" : { + "fips-us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "deprecated" : true, + "hostname" : "network-firewall-fips.us-gov-east-1.amazonaws.com" + }, + "fips-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "hostname" : "network-firewall-fips.us-gov-west-1.amazonaws.com" + }, + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "network-firewall-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "network-firewall-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, + "networkmanager" : { + "endpoints" : { + "aws-us-gov-global" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "networkmanager.us-gov-west-1.amazonaws.com" + } + }, + "isRegionalized" : false, + "partitionEndpoint" : "aws-us-gov-global" + }, + "oidc" : { + "endpoints" : { + "us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "hostname" : "oidc.us-gov-east-1.amazonaws.com" + }, + "us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "oidc.us-gov-west-1.amazonaws.com" + } + } + }, "organizations" : { "endpoints" : { "aws-us-gov-global" : { "credentialScope" : { "region" : "us-gov-west-1" }, - "hostname" : "organizations.us-gov-west-1.amazonaws.com" + "hostname" : "organizations.us-gov-west-1.amazonaws.com", + "variants" : [ { + "hostname" : "organizations.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] }, "fips-aws-us-gov-global" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "organizations.us-gov-west-1.amazonaws.com" } }, @@ -8356,13 +16240,18 @@ "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "pinpoint-fips.us-gov-west-1.amazonaws.com" }, "us-gov-west-1" : { "credentialScope" : { "region" : "us-gov-west-1" }, - "hostname" : "pinpoint.us-gov-west-1.amazonaws.com" + "hostname" : "pinpoint.us-gov-west-1.amazonaws.com", + "variants" : [ { + "hostname" : "pinpoint-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] } } }, @@ -8372,33 +16261,103 @@ "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "polly-fips.us-gov-west-1.amazonaws.com" }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "polly-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, + "portal.sso" : { + "endpoints" : { + "us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "hostname" : "portal.sso.us-gov-east-1.amazonaws.com" + }, + "us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "portal.sso.us-gov-west-1.amazonaws.com" + } + } + }, + "quicksight" : { + "endpoints" : { + "api" : { }, "us-gov-west-1" : { } } }, "ram" : { "endpoints" : { - "us-gov-east-1" : { }, - "us-gov-west-1" : { } + "us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "hostname" : "ram.us-gov-east-1.amazonaws.com" + }, + "us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "ram.us-gov-west-1.amazonaws.com" + } } }, "rds" : { + "defaults" : { + "variants" : [ { + "hostname" : "rds.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] + }, "endpoints" : { "rds.us-gov-east-1" : { "credentialScope" : { "region" : "us-gov-east-1" }, + "deprecated" : true, "hostname" : "rds.us-gov-east-1.amazonaws.com" }, "rds.us-gov-west-1" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "rds.us-gov-west-1.amazonaws.com" }, - "us-gov-east-1" : { }, - "us-gov-west-1" : { } + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "rds.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-east-1-fips" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "deprecated" : true, + "hostname" : "rds.us-gov-east-1.amazonaws.com" + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "rds.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1-fips" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "hostname" : "rds.us-gov-west-1.amazonaws.com" + } } }, "redshift" : { @@ -8423,27 +16382,68 @@ "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "rekognition-fips.us-gov-west-1.amazonaws.com" }, - "us-gov-west-1" : { } + "rekognition.us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "variants" : [ { + "hostname" : "rekognition-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "rekognition-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1-fips" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "hostname" : "rekognition-fips.us-gov-west-1.amazonaws.com" + } } }, "resource-groups" : { + "defaults" : { + "variants" : [ { + "hostname" : "resource-groups.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] + }, "endpoints" : { "fips-us-gov-east-1" : { "credentialScope" : { "region" : "us-gov-east-1" }, + "deprecated" : true, "hostname" : "resource-groups.us-gov-east-1.amazonaws.com" }, "fips-us-gov-west-1" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "resource-groups.us-gov-west-1.amazonaws.com" }, - "us-gov-east-1" : { }, - "us-gov-west-1" : { } + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "resource-groups.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "resource-groups.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "route53" : { @@ -8452,12 +16452,17 @@ "credentialScope" : { "region" : "us-gov-west-1" }, - "hostname" : "route53.us-gov.amazonaws.com" + "hostname" : "route53.us-gov.amazonaws.com", + "variants" : [ { + "hostname" : "route53.us-gov.amazonaws.com", + "tags" : [ "fips" ] + } ] }, "fips-aws-us-gov-global" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "route53.us-gov.amazonaws.com" } }, @@ -8470,36 +16475,120 @@ "us-gov-west-1" : { } } }, + "runtime.lex" : { + "defaults" : { + "credentialScope" : { + "service" : "lex" + }, + "variants" : [ { + "hostname" : "runtime-fips.lex.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] + }, + "endpoints" : { + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "runtime-fips.lex.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1-fips" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "hostname" : "runtime-fips.lex.us-gov-west-1.amazonaws.com" + } + } + }, "runtime.sagemaker" : { + "defaults" : { + "variants" : [ { + "hostname" : "runtime.sagemaker.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] + }, "endpoints" : { - "us-gov-west-1" : { } + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "runtime.sagemaker.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1-fips" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "hostname" : "runtime.sagemaker.us-gov-west-1.amazonaws.com" + } } }, "s3" : { "defaults" : { - "signatureVersions" : [ "s3", "s3v4" ] + "signatureVersions" : [ "s3", "s3v4" ], + "variants" : [ { + "dnsSuffix" : "amazonaws.com", + "hostname" : "{service}-fips.dualstack.{region}.{dnsSuffix}", + "tags" : [ "dualstack", "fips" ] + }, { + "dnsSuffix" : "amazonaws.com", + "hostname" : "{service}.dualstack.{region}.{dnsSuffix}", + "tags" : [ "dualstack" ] + } ] }, "endpoints" : { + "fips-us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "deprecated" : true, + "hostname" : "s3-fips.us-gov-east-1.amazonaws.com" + }, "fips-us-gov-west-1" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "s3-fips.us-gov-west-1.amazonaws.com" }, "us-gov-east-1" : { "hostname" : "s3.us-gov-east-1.amazonaws.com", - "protocols" : [ "http", "https" ] + "protocols" : [ "http", "https" ], + "variants" : [ { + "hostname" : "s3-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + }, { + "hostname" : "s3.dualstack.us-gov-east-1.amazonaws.com", + "tags" : [ "dualstack" ] + } ] }, "us-gov-west-1" : { "hostname" : "s3.us-gov-west-1.amazonaws.com", - "protocols" : [ "http", "https" ] + "protocols" : [ "http", "https" ], + "variants" : [ { + "hostname" : "s3-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + }, { + "hostname" : "s3.dualstack.us-gov-west-1.amazonaws.com", + "tags" : [ "dualstack" ] + } ] } } }, "s3-control" : { "defaults" : { "protocols" : [ "https" ], - "signatureVersions" : [ "s3v4" ] + "signatureVersions" : [ "s3v4" ], + "variants" : [ { + "dnsSuffix" : "amazonaws.com", + "hostname" : "{service}-fips.dualstack.{region}.{dnsSuffix}", + "tags" : [ "dualstack", "fips" ] + }, { + "dnsSuffix" : "amazonaws.com", + "hostname" : "{service}.dualstack.{region}.{dnsSuffix}", + "tags" : [ "dualstack" ] + } ] }, "endpoints" : { "us-gov-east-1" : { @@ -8507,12 +16596,23 @@ "region" : "us-gov-east-1" }, "hostname" : "s3-control.us-gov-east-1.amazonaws.com", - "signatureVersions" : [ "s3v4" ] + "signatureVersions" : [ "s3v4" ], + "variants" : [ { + "hostname" : "s3-control-fips.dualstack.us-gov-east-1.amazonaws.com", + "tags" : [ "dualstack", "fips" ] + }, { + "hostname" : "s3-control-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + }, { + "hostname" : "s3-control.dualstack.us-gov-east-1.amazonaws.com", + "tags" : [ "dualstack" ] + } ] }, "us-gov-east-1-fips" : { "credentialScope" : { "region" : "us-gov-east-1" }, + "deprecated" : true, "hostname" : "s3-control-fips.us-gov-east-1.amazonaws.com", "signatureVersions" : [ "s3v4" ] }, @@ -8521,31 +16621,74 @@ "region" : "us-gov-west-1" }, "hostname" : "s3-control.us-gov-west-1.amazonaws.com", - "signatureVersions" : [ "s3v4" ] + "signatureVersions" : [ "s3v4" ], + "variants" : [ { + "hostname" : "s3-control-fips.dualstack.us-gov-west-1.amazonaws.com", + "tags" : [ "dualstack", "fips" ] + }, { + "hostname" : "s3-control-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + }, { + "hostname" : "s3-control.dualstack.us-gov-west-1.amazonaws.com", + "tags" : [ "dualstack" ] + } ] }, "us-gov-west-1-fips" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "s3-control-fips.us-gov-west-1.amazonaws.com", "signatureVersions" : [ "s3v4" ] } } }, + "s3-outposts" : { + "endpoints" : { + "fips-us-gov-east-1" : { + "deprecated" : true + }, + "fips-us-gov-west-1" : { + "deprecated" : true + }, + "us-gov-east-1" : { + "variants" : [ { + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "tags" : [ "fips" ] + } ] + } + } + }, "secretsmanager" : { "endpoints" : { - "us-gov-east-1" : { }, + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "secretsmanager-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-gov-east-1-fips" : { "credentialScope" : { "region" : "us-gov-east-1" }, + "deprecated" : true, "hostname" : "secretsmanager-fips.us-gov-east-1.amazonaws.com" }, - "us-gov-west-1" : { }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "secretsmanager-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-gov-west-1-fips" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "secretsmanager-fips.us-gov-west-1.amazonaws.com" } } @@ -8556,16 +16699,28 @@ "credentialScope" : { "region" : "us-gov-east-1" }, + "deprecated" : true, "hostname" : "securityhub-fips.us-gov-east-1.amazonaws.com" }, "fips-us-gov-west-1" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "securityhub-fips.us-gov-west-1.amazonaws.com" }, - "us-gov-east-1" : { }, - "us-gov-west-1" : { } + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "securityhub-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "securityhub-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "serverlessrepo" : { @@ -8591,38 +16746,182 @@ }, "servicecatalog" : { "endpoints" : { - "us-gov-east-1" : { }, + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "servicecatalog-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-gov-east-1-fips" : { "credentialScope" : { "region" : "us-gov-east-1" }, + "deprecated" : true, "hostname" : "servicecatalog-fips.us-gov-east-1.amazonaws.com" }, - "us-gov-west-1" : { }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "servicecatalog-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-gov-west-1-fips" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "servicecatalog-fips.us-gov-west-1.amazonaws.com" } } }, + "servicecatalog-appregistry" : { + "defaults" : { + "variants" : [ { + "hostname" : "servicecatalog-appregistry.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] + }, + "endpoints" : { + "fips-us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "deprecated" : true, + "hostname" : "servicecatalog-appregistry.us-gov-east-1.amazonaws.com" + }, + "fips-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "hostname" : "servicecatalog-appregistry.us-gov-west-1.amazonaws.com" + }, + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "servicecatalog-appregistry.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "servicecatalog-appregistry.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, + "servicediscovery" : { + "endpoints" : { + "servicediscovery" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "variants" : [ { + "hostname" : "servicediscovery-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "servicediscovery-fips" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "hostname" : "servicediscovery-fips.us-gov-west-1.amazonaws.com" + }, + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "servicediscovery-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-east-1-fips" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "deprecated" : true, + "hostname" : "servicediscovery-fips.us-gov-east-1.amazonaws.com" + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "servicediscovery-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1-fips" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "hostname" : "servicediscovery-fips.us-gov-west-1.amazonaws.com" + } + } + }, + "servicequotas" : { + "defaults" : { + "protocols" : [ "https" ], + "variants" : [ { + "hostname" : "servicequotas.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] + }, + "endpoints" : { + "fips-us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "deprecated" : true, + "hostname" : "servicequotas.us-gov-east-1.amazonaws.com" + }, + "fips-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "hostname" : "servicequotas.us-gov-west-1.amazonaws.com" + }, + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "servicequotas.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "servicequotas.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, "sms" : { "endpoints" : { "fips-us-gov-east-1" : { "credentialScope" : { "region" : "us-gov-east-1" }, + "deprecated" : true, "hostname" : "sms-fips.us-gov-east-1.amazonaws.com" }, "fips-us-gov-west-1" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "sms-fips.us-gov-west-1.amazonaws.com" }, - "us-gov-east-1" : { }, - "us-gov-west-1" : { } + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "sms-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "sms-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "snowball" : { @@ -8631,36 +16930,68 @@ "credentialScope" : { "region" : "us-gov-east-1" }, + "deprecated" : true, "hostname" : "snowball-fips.us-gov-east-1.amazonaws.com" }, "fips-us-gov-west-1" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "snowball-fips.us-gov-west-1.amazonaws.com" }, - "us-gov-east-1" : { }, - "us-gov-west-1" : { } + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "snowball-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "snowball-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "sns" : { "endpoints" : { - "us-gov-east-1" : { + "fips-us-gov-east-1" : { "credentialScope" : { "region" : "us-gov-east-1" }, + "deprecated" : true, "hostname" : "sns.us-gov-east-1.amazonaws.com" }, - "us-gov-west-1" : { + "fips-us-gov-west-1" : { "credentialScope" : { "region" : "us-gov-west-1" }, - "hostname" : "sns.us-gov-west-1.amazonaws.com", - "protocols" : [ "http", "https" ] + "deprecated" : true, + "hostname" : "sns.us-gov-west-1.amazonaws.com" + }, + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "sns.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "protocols" : [ "http", "https" ], + "variants" : [ { + "hostname" : "sns.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] } } }, "sqs" : { + "defaults" : { + "variants" : [ { + "hostname" : "sqs.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] + }, "endpoints" : { "us-gov-east-1" : { "credentialScope" : { @@ -8679,21 +17010,39 @@ } }, "ssm" : { + "defaults" : { + "variants" : [ { + "hostname" : "ssm.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] + }, "endpoints" : { "fips-us-gov-east-1" : { "credentialScope" : { "region" : "us-gov-east-1" }, + "deprecated" : true, "hostname" : "ssm.us-gov-east-1.amazonaws.com" }, "fips-us-gov-west-1" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "ssm.us-gov-west-1.amazonaws.com" }, - "us-gov-east-1" : { }, - "us-gov-west-1" : { } + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "ssm.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "ssm.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "states" : { @@ -8702,16 +17051,28 @@ "credentialScope" : { "region" : "us-gov-east-1" }, + "deprecated" : true, "hostname" : "states-fips.us-gov-east-1.amazonaws.com" }, "fips-us-gov-west-1" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "states.us-gov-west-1.amazonaws.com" }, - "us-gov-east-1" : { }, - "us-gov-west-1" : { } + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "states-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "states.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "storagegateway" : { @@ -8720,49 +17081,108 @@ "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "storagegateway-fips.us-gov-west-1.amazonaws.com" }, - "us-gov-east-1" : { }, - "us-gov-west-1" : { } + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "storagegateway-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-east-1-fips" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "deprecated" : true, + "hostname" : "storagegateway-fips.us-gov-east-1.amazonaws.com" + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "storagegateway-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1-fips" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "hostname" : "storagegateway-fips.us-gov-west-1.amazonaws.com" + } } }, "streams.dynamodb" : { "defaults" : { "credentialScope" : { "service" : "dynamodb" - } + }, + "variants" : [ { + "hostname" : "streams.dynamodb.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] }, "endpoints" : { - "us-gov-east-1" : { }, + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "streams.dynamodb.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-gov-east-1-fips" : { "credentialScope" : { "region" : "us-gov-east-1" }, - "hostname" : "dynamodb.us-gov-east-1.amazonaws.com" + "deprecated" : true, + "hostname" : "streams.dynamodb.us-gov-east-1.amazonaws.com" + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "streams.dynamodb.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] }, - "us-gov-west-1" : { }, "us-gov-west-1-fips" : { "credentialScope" : { "region" : "us-gov-west-1" }, - "hostname" : "dynamodb.us-gov-west-1.amazonaws.com" + "deprecated" : true, + "hostname" : "streams.dynamodb.us-gov-west-1.amazonaws.com" } } }, "sts" : { + "defaults" : { + "variants" : [ { + "hostname" : "sts.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] + }, "endpoints" : { - "us-gov-east-1" : { }, + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "sts.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-gov-east-1-fips" : { "credentialScope" : { "region" : "us-gov-east-1" }, + "deprecated" : true, "hostname" : "sts.us-gov-east-1.amazonaws.com" }, - "us-gov-west-1" : { }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "sts.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-gov-west-1-fips" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "sts.us-gov-west-1.amazonaws.com" } } @@ -8779,7 +17199,18 @@ "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "support.us-gov-west-1.amazonaws.com" + }, + "us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "variants" : [ { + "hostname" : "support.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] } }, "partitionEndpoint" : "aws-us-gov-global" @@ -8800,31 +17231,83 @@ } } }, + "synthetics" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, "tagging" : { "endpoints" : { "us-gov-east-1" : { }, "us-gov-west-1" : { } } }, + "textract" : { + "endpoints" : { + "fips-us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "deprecated" : true, + "hostname" : "textract-fips.us-gov-east-1.amazonaws.com" + }, + "fips-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "hostname" : "textract-fips.us-gov-west-1.amazonaws.com" + }, + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "textract-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "textract-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, "transcribe" : { "defaults" : { - "protocols" : [ "https" ] + "protocols" : [ "https" ], + "variants" : [ { + "hostname" : "fips.transcribe.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] }, "endpoints" : { "fips-us-gov-east-1" : { "credentialScope" : { "region" : "us-gov-east-1" }, + "deprecated" : true, "hostname" : "fips.transcribe.us-gov-east-1.amazonaws.com" }, "fips-us-gov-west-1" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "fips.transcribe.us-gov-west-1.amazonaws.com" }, - "us-gov-east-1" : { }, - "us-gov-west-1" : { } + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "fips.transcribe.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "fips.transcribe.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "transfer" : { @@ -8833,16 +17316,28 @@ "credentialScope" : { "region" : "us-gov-east-1" }, + "deprecated" : true, "hostname" : "transfer-fips.us-gov-east-1.amazonaws.com" }, "fips-us-gov-west-1" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "transfer-fips.us-gov-west-1.amazonaws.com" }, - "us-gov-east-1" : { }, - "us-gov-west-1" : { } + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "transfer-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "transfer-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "translate" : { @@ -8850,28 +17345,56 @@ "protocols" : [ "https" ] }, "endpoints" : { - "us-gov-west-1" : { }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "translate-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-gov-west-1-fips" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "translate-fips.us-gov-west-1.amazonaws.com" } } }, "waf-regional" : { "endpoints" : { + "fips-us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "deprecated" : true, + "hostname" : "waf-regional-fips.us-gov-east-1.amazonaws.com" + }, "fips-us-gov-west-1" : { "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "waf-regional-fips.us-gov-west-1.amazonaws.com" }, + "us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "hostname" : "waf-regional.us-gov-east-1.amazonaws.com", + "variants" : [ { + "hostname" : "waf-regional-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-gov-west-1" : { "credentialScope" : { "region" : "us-gov-west-1" }, - "hostname" : "waf-regional.us-gov-west-1.amazonaws.com" + "hostname" : "waf-regional.us-gov-west-1.amazonaws.com", + "variants" : [ { + "hostname" : "waf-regional-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] } } }, @@ -8881,15 +17404,45 @@ "credentialScope" : { "region" : "us-gov-west-1" }, + "deprecated" : true, "hostname" : "workspaces-fips.us-gov-west-1.amazonaws.com" }, - "us-gov-west-1" : { } + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "workspaces-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "xray" : { "endpoints" : { - "us-gov-east-1" : { }, - "us-gov-west-1" : { } + "fips-us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "deprecated" : true, + "hostname" : "xray-fips.us-gov-east-1.amazonaws.com" + }, + "fips-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "hostname" : "xray-fips.us-gov-west-1.amazonaws.com" + }, + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "xray-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "xray-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } } } @@ -8897,7 +17450,12 @@ "defaults" : { "hostname" : "{service}.{region}.{dnsSuffix}", "protocols" : [ "https" ], - "signatureVersions" : [ "v4" ] + "signatureVersions" : [ "v4" ], + "variants" : [ { + "dnsSuffix" : "c2s.ic.gov", + "hostname" : "{service}-fips.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] }, "dnsSuffix" : "c2s.ic.gov", "partition" : "aws-iso", @@ -8906,6 +17464,9 @@ "regions" : { "us-iso-east-1" : { "description" : "US ISO East" + }, + "us-iso-west-1" : { + "description" : "US ISO WEST" } }, "services" : { @@ -8916,6 +17477,12 @@ "region" : "us-iso-east-1" }, "hostname" : "api.ecr.us-iso-east-1.c2s.ic.gov" + }, + "us-iso-west-1" : { + "credentialScope" : { + "region" : "us-iso-west-1" + }, + "hostname" : "api.ecr.us-iso-west-1.c2s.ic.gov" } } }, @@ -8934,29 +17501,34 @@ "protocols" : [ "http", "https" ] }, "endpoints" : { - "us-iso-east-1" : { } + "us-iso-east-1" : { }, + "us-iso-west-1" : { } } }, "autoscaling" : { "endpoints" : { "us-iso-east-1" : { "protocols" : [ "http", "https" ] - } + }, + "us-iso-west-1" : { } } }, "cloudformation" : { "endpoints" : { - "us-iso-east-1" : { } + "us-iso-east-1" : { }, + "us-iso-west-1" : { } } }, "cloudtrail" : { "endpoints" : { - "us-iso-east-1" : { } + "us-iso-east-1" : { }, + "us-iso-west-1" : { } } }, "codedeploy" : { "endpoints" : { - "us-iso-east-1" : { } + "us-iso-east-1" : { }, + "us-iso-west-1" : { } } }, "comprehend" : { @@ -8969,7 +17541,8 @@ }, "config" : { "endpoints" : { - "us-iso-east-1" : { } + "us-iso-east-1" : { }, + "us-iso-west-1" : { } } }, "datapipeline" : { @@ -8979,18 +17552,61 @@ }, "directconnect" : { "endpoints" : { - "us-iso-east-1" : { } + "us-iso-east-1" : { }, + "us-iso-west-1" : { } } }, "dms" : { + "defaults" : { + "variants" : [ { + "hostname" : "dms.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] + }, "endpoints" : { + "dms" : { + "credentialScope" : { + "region" : "us-iso-east-1" + }, + "deprecated" : true, + "variants" : [ { + "hostname" : "dms.us-iso-east-1.c2s.ic.gov", + "tags" : [ "fips" ] + } ] + }, "dms-fips" : { "credentialScope" : { "region" : "us-iso-east-1" }, + "deprecated" : true, "hostname" : "dms.us-iso-east-1.c2s.ic.gov" }, - "us-iso-east-1" : { } + "us-iso-east-1" : { + "variants" : [ { + "hostname" : "dms.us-iso-east-1.c2s.ic.gov", + "tags" : [ "fips" ] + } ] + }, + "us-iso-east-1-fips" : { + "credentialScope" : { + "region" : "us-iso-east-1" + }, + "deprecated" : true, + "hostname" : "dms.us-iso-east-1.c2s.ic.gov" + }, + "us-iso-west-1" : { + "variants" : [ { + "hostname" : "dms.us-iso-west-1.c2s.ic.gov", + "tags" : [ "fips" ] + } ] + }, + "us-iso-west-1-fips" : { + "credentialScope" : { + "region" : "us-iso-west-1" + }, + "deprecated" : true, + "hostname" : "dms.us-iso-west-1.c2s.ic.gov" + } } }, "ds" : { @@ -9002,36 +17618,64 @@ "endpoints" : { "us-iso-east-1" : { "protocols" : [ "http", "https" ] - } + }, + "us-iso-west-1" : { } } }, - "ec2" : { + "ebs" : { "endpoints" : { "us-iso-east-1" : { } } }, + "ec2" : { + "endpoints" : { + "us-iso-east-1" : { }, + "us-iso-west-1" : { } + } + }, "ecs" : { "endpoints" : { - "us-iso-east-1" : { } + "us-iso-east-1" : { }, + "us-iso-west-1" : { } } }, "elasticache" : { "endpoints" : { - "us-iso-east-1" : { } + "us-iso-east-1" : { }, + "us-iso-west-1" : { } + } + }, + "elasticfilesystem" : { + "endpoints" : { + "fips-us-iso-east-1" : { + "credentialScope" : { + "region" : "us-iso-east-1" + }, + "deprecated" : true, + "hostname" : "elasticfilesystem-fips.us-iso-east-1.c2s.ic.gov" + }, + "us-iso-east-1" : { + "variants" : [ { + "hostname" : "elasticfilesystem-fips.us-iso-east-1.c2s.ic.gov", + "tags" : [ "fips" ] + } ] + } } }, "elasticloadbalancing" : { "endpoints" : { "us-iso-east-1" : { "protocols" : [ "http", "https" ] - } + }, + "us-iso-west-1" : { } } }, "elasticmapreduce" : { "endpoints" : { "us-iso-east-1" : { "protocols" : [ "https" ] - } + }, + "us-iso-west-1" : { } } }, "es" : { @@ -9040,6 +17684,12 @@ } }, "events" : { + "endpoints" : { + "us-iso-east-1" : { }, + "us-iso-west-1" : { } + } + }, + "firehose" : { "endpoints" : { "us-iso-east-1" : { } } @@ -9048,7 +17698,8 @@ "endpoints" : { "us-iso-east-1" : { "protocols" : [ "http", "https" ] - } + }, + "us-iso-west-1" : { } } }, "health" : { @@ -9070,7 +17721,8 @@ }, "kinesis" : { "endpoints" : { - "us-iso-east-1" : { } + "us-iso-east-1" : { }, + "us-iso-west-1" : { } } }, "kms" : { @@ -9079,34 +17731,90 @@ "credentialScope" : { "region" : "us-iso-east-1" }, + "deprecated" : true, "hostname" : "kms-fips.us-iso-east-1.c2s.ic.gov" }, - "us-iso-east-1" : { } + "us-iso-east-1" : { + "variants" : [ { + "hostname" : "kms-fips.us-iso-east-1.c2s.ic.gov", + "tags" : [ "fips" ] + } ] + }, + "us-iso-east-1-fips" : { + "credentialScope" : { + "region" : "us-iso-east-1" + }, + "deprecated" : true, + "hostname" : "kms-fips.us-iso-east-1.c2s.ic.gov" + }, + "us-iso-west-1" : { + "variants" : [ { + "hostname" : "kms-fips.us-iso-west-1.c2s.ic.gov", + "tags" : [ "fips" ] + } ] + }, + "us-iso-west-1-fips" : { + "credentialScope" : { + "region" : "us-iso-west-1" + }, + "deprecated" : true, + "hostname" : "kms-fips.us-iso-west-1.c2s.ic.gov" + } } }, "lambda" : { + "endpoints" : { + "us-iso-east-1" : { }, + "us-iso-west-1" : { } + } + }, + "license-manager" : { "endpoints" : { "us-iso-east-1" : { } } }, "logs" : { + "endpoints" : { + "us-iso-east-1" : { }, + "us-iso-west-1" : { } + } + }, + "medialive" : { + "endpoints" : { + "us-iso-east-1" : { } + } + }, + "mediapackage" : { "endpoints" : { "us-iso-east-1" : { } } }, "monitoring" : { + "endpoints" : { + "us-iso-east-1" : { }, + "us-iso-west-1" : { } + } + }, + "outposts" : { "endpoints" : { "us-iso-east-1" : { } } }, - "rds" : { + "ram" : { "endpoints" : { "us-iso-east-1" : { } } }, + "rds" : { + "endpoints" : { + "us-iso-east-1" : { }, + "us-iso-west-1" : { } + } + }, "redshift" : { "endpoints" : { - "us-iso-east-1" : { } + "us-iso-east-1" : { }, + "us-iso-west-1" : { } } }, "route53" : { @@ -9121,6 +17829,11 @@ "isRegionalized" : false, "partitionEndpoint" : "aws-iso-global" }, + "route53resolver" : { + "endpoints" : { + "us-iso-east-1" : { } + } + }, "runtime.sagemaker" : { "endpoints" : { "us-iso-east-1" : { } @@ -9134,7 +17847,13 @@ "us-iso-east-1" : { "protocols" : [ "http", "https" ], "signatureVersions" : [ "s3v4" ] - } + }, + "us-iso-west-1" : { } + } + }, + "secretsmanager" : { + "endpoints" : { + "us-iso-east-1" : { } } }, "snowball" : { @@ -9146,37 +17865,43 @@ "endpoints" : { "us-iso-east-1" : { "protocols" : [ "http", "https" ] - } + }, + "us-iso-west-1" : { } } }, "sqs" : { "endpoints" : { "us-iso-east-1" : { "protocols" : [ "http", "https" ] - } + }, + "us-iso-west-1" : { } } }, - "states" : { + "ssm" : { "endpoints" : { "us-iso-east-1" : { } } }, + "states" : { + "endpoints" : { + "us-iso-east-1" : { }, + "us-iso-west-1" : { } + } + }, "streams.dynamodb" : { "defaults" : { "credentialScope" : { "service" : "dynamodb" - }, - "protocols" : [ "http", "https" ] + } }, "endpoints" : { - "us-iso-east-1" : { - "protocols" : [ "http", "https" ] - } + "us-iso-east-1" : { } } }, "sts" : { "endpoints" : { - "us-iso-east-1" : { } + "us-iso-east-1" : { }, + "us-iso-west-1" : { } } }, "support" : { @@ -9191,6 +17916,12 @@ "partitionEndpoint" : "aws-iso-global" }, "swf" : { + "endpoints" : { + "us-iso-east-1" : { }, + "us-iso-west-1" : { } + } + }, + "synthetics" : { "endpoints" : { "us-iso-east-1" : { } } @@ -9226,7 +17957,12 @@ "defaults" : { "hostname" : "{service}.{region}.{dnsSuffix}", "protocols" : [ "https" ], - "signatureVersions" : [ "v4" ] + "signatureVersions" : [ "v4" ], + "variants" : [ { + "dnsSuffix" : "sc2s.sgov.gov", + "hostname" : "{service}-fips.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] }, "dnsSuffix" : "sc2s.sgov.gov", "partition" : "aws-iso-b", @@ -9290,13 +18026,47 @@ } }, "dms" : { + "defaults" : { + "variants" : [ { + "hostname" : "dms.{region}.{dnsSuffix}", + "tags" : [ "fips" ] + } ] + }, "endpoints" : { + "dms" : { + "credentialScope" : { + "region" : "us-isob-east-1" + }, + "deprecated" : true, + "variants" : [ { + "hostname" : "dms.us-isob-east-1.sc2s.sgov.gov", + "tags" : [ "fips" ] + } ] + }, "dms-fips" : { "credentialScope" : { "region" : "us-isob-east-1" }, + "deprecated" : true, "hostname" : "dms.us-isob-east-1.sc2s.sgov.gov" }, + "us-isob-east-1" : { + "variants" : [ { + "hostname" : "dms.us-isob-east-1.sc2s.sgov.gov", + "tags" : [ "fips" ] + } ] + }, + "us-isob-east-1-fips" : { + "credentialScope" : { + "region" : "us-isob-east-1" + }, + "deprecated" : true, + "hostname" : "dms.us-isob-east-1.sc2s.sgov.gov" + } + } + }, + "ds" : { + "endpoints" : { "us-isob-east-1" : { } } }, @@ -9308,6 +18078,11 @@ "us-isob-east-1" : { } } }, + "ebs" : { + "endpoints" : { + "us-isob-east-1" : { } + } + }, "ec2" : { "defaults" : { "protocols" : [ "http", "https" ] @@ -9381,9 +18156,22 @@ "credentialScope" : { "region" : "us-isob-east-1" }, + "deprecated" : true, "hostname" : "kms-fips.us-isob-east-1.sc2s.sgov.gov" }, - "us-isob-east-1" : { } + "us-isob-east-1" : { + "variants" : [ { + "hostname" : "kms-fips.us-isob-east-1.sc2s.sgov.gov", + "tags" : [ "fips" ] + } ] + }, + "us-isob-east-1-fips" : { + "credentialScope" : { + "region" : "us-isob-east-1" + }, + "deprecated" : true, + "hostname" : "kms-fips.us-isob-east-1.sc2s.sgov.gov" + } } }, "lambda" : { @@ -9416,6 +18204,18 @@ "us-isob-east-1" : { } } }, + "route53" : { + "endpoints" : { + "aws-iso-b-global" : { + "credentialScope" : { + "region" : "us-isob-east-1" + }, + "hostname" : "route53.sc2s.sgov.gov" + } + }, + "isRegionalized" : false, + "partitionEndpoint" : "aws-iso-b-global" + }, "s3" : { "defaults" : { "protocols" : [ "http", "https" ], @@ -9488,6 +18288,16 @@ "endpoints" : { "us-isob-east-1" : { } } + }, + "synthetics" : { + "endpoints" : { + "us-isob-east-1" : { } + } + }, + "tagging" : { + "endpoints" : { + "us-isob-east-1" : { } + } } } } ], diff --git a/aws/sdk/aws-models/amplify.json b/aws/sdk/aws-models/amplify.json index e36f3dc08d..55cfdb00be 100644 --- a/aws/sdk/aws-models/amplify.json +++ b/aws/sdk/aws-models/amplify.json @@ -36,6 +36,7 @@ "min": 1, "max": 255 }, + "smithy.api#pattern": "^(?s).+$", "smithy.api#sensitive": {} } }, @@ -223,7 +224,7 @@ "repository": { "target": "com.amazonaws.amplify#Repository", "traits": { - "smithy.api#documentation": "

The repository for the Amplify app.

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

The Git repository for the Amplify app.

", "smithy.api#required": {} } }, @@ -291,7 +292,7 @@ "basicAuthCredentials": { "target": "com.amazonaws.amplify#BasicAuthCredentials", "traits": { - "smithy.api#documentation": "

The basic authorization credentials for branches for the Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.

" + "smithy.api#documentation": "

The basic authorization credentials for branches for the Amplify app. You must\n base64-encode the authorization credentials and provide them in the format\n user:password.

" } }, "customRules": { @@ -335,6 +336,12 @@ "traits": { "smithy.api#documentation": "

Describes the automated branch creation configuration for the Amplify app.

" } + }, + "repositoryCloneMethod": { + "target": "com.amazonaws.amplify#RepositoryCloneMethod", + "traits": { + "smithy.api#documentation": "

The authentication protocol to use to access the Git repository for an Amplify app.\n For a GitHub repository, specify TOKEN. For an Amazon Web Services CodeCommit repository,\n specify SIGV4. For GitLab and Bitbucket repositories, specify\n SSH.

" + } } }, "traits": { @@ -403,7 +410,8 @@ "smithy.api#length": { "min": 0, "max": 255 - } + }, + "smithy.api#pattern": "^(?s)" } }, "com.amazonaws.amplify#ArtifactUrl": { @@ -475,7 +483,7 @@ "basicAuthCredentials": { "target": "com.amazonaws.amplify#BasicAuthCredentials", "traits": { - "smithy.api#documentation": "

The basic authorization credentials for the autocreated branch. You must base64-encode the authorization credentials and provide them in the format user:password.

" + "smithy.api#documentation": "

The basic authorization credentials for the autocreated branch. You must\n base64-encode the authorization credentials and provide them in the format\n user:password.

" } }, "enableBasicAuth": { @@ -487,7 +495,7 @@ "enablePerformanceMode": { "target": "com.amazonaws.amplify#EnablePerformanceMode", "traits": { - "smithy.api#documentation": "

Enables performance mode for the branch.

\n

Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.

" + "smithy.api#documentation": "

Enables performance mode for the branch.

\n

Performance mode optimizes for faster hosting performance by keeping content cached at\n the edge for a longer interval. When performance mode is enabled, hosting configuration\n or code changes can take up to 10 minutes to roll out.

" } }, "buildSpec": { @@ -519,7 +527,8 @@ "smithy.api#length": { "min": 1, "max": 2048 - } + }, + "smithy.api#pattern": "^(?s).+$" } }, "com.amazonaws.amplify#AutoBranchCreationPatterns": { @@ -534,7 +543,8 @@ "smithy.api#length": { "min": 1, "max": 2048 - } + }, + "smithy.api#pattern": "^(?s).+$" } }, "com.amazonaws.amplify#AutoSubDomainCreationPatterns": { @@ -605,9 +615,10 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 1, + "min": 0, "max": 1000 - } + }, + "smithy.api#pattern": "^(?s)" } }, "com.amazonaws.amplify#BackendEnvironments": { @@ -636,6 +647,7 @@ "min": 0, "max": 2000 }, + "smithy.api#pattern": "^(?s)", "smithy.api#sensitive": {} } }, @@ -756,7 +768,7 @@ "enablePerformanceMode": { "target": "com.amazonaws.amplify#EnablePerformanceMode", "traits": { - "smithy.api#documentation": "

Enables performance mode for the branch.

\n

Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.

" + "smithy.api#documentation": "

Enables performance mode for the branch.

\n

Performance mode optimizes for faster hosting performance by keeping content cached at\n the edge for a longer interval. When performance mode is enabled, hosting configuration\n or code changes can take up to 10 minutes to roll out.

" } }, "thumbnailUrl": { @@ -768,7 +780,7 @@ "basicAuthCredentials": { "target": "com.amazonaws.amplify#BasicAuthCredentials", "traits": { - "smithy.api#documentation": "

The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.

" + "smithy.api#documentation": "

The basic authorization credentials for a branch of an Amplify app. You must\n base64-encode the authorization credentials and provide them in the format\n user:password.

" } }, "buildSpec": { @@ -832,7 +844,8 @@ "smithy.api#length": { "min": 0, "max": 1000 - } + }, + "smithy.api#pattern": "^(?s)" } }, "com.amazonaws.amplify#BranchName": { @@ -841,7 +854,8 @@ "smithy.api#length": { "min": 1, "max": 255 - } + }, + "smithy.api#pattern": "^(?s).+$" } }, "com.amazonaws.amplify#Branches": { @@ -863,7 +877,9 @@ "smithy.api#length": { "min": 1, "max": 25000 - } + }, + "smithy.api#pattern": "^(?s).+$", + "smithy.api#sensitive": {} } }, "com.amazonaws.amplify#CertificateVerificationDNSRecord": { @@ -884,7 +900,8 @@ "smithy.api#length": { "min": 0, "max": 255 - } + }, + "smithy.api#pattern": "^(?s)" } }, "com.amazonaws.amplify#CommitMessage": { @@ -893,7 +910,8 @@ "smithy.api#length": { "min": 0, "max": 10000 - } + }, + "smithy.api#pattern": "^(?s)" } }, "com.amazonaws.amplify#CommitTime": { @@ -903,9 +921,10 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 1, + "min": 0, "max": 2048 - } + }, + "smithy.api#pattern": "^(?s)" } }, "com.amazonaws.amplify#Context": { @@ -1018,7 +1037,7 @@ "basicAuthCredentials": { "target": "com.amazonaws.amplify#BasicAuthCredentials", "traits": { - "smithy.api#documentation": "

The credentials for basic authorization for an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.

" + "smithy.api#documentation": "

The credentials for basic authorization for an Amplify app. You must base64-encode\n the authorization credentials and provide them in the format\n user:password.

" } }, "customRules": { @@ -1257,7 +1276,7 @@ "basicAuthCredentials": { "target": "com.amazonaws.amplify#BasicAuthCredentials", "traits": { - "smithy.api#documentation": "

The basic authorization credentials for the branch. You must base64-encode the authorization credentials and provide them in the format user:password.

" + "smithy.api#documentation": "

The basic authorization credentials for the branch. You must base64-encode the\n authorization credentials and provide them in the format\n user:password.

" } }, "enableBasicAuth": { @@ -1269,7 +1288,7 @@ "enablePerformanceMode": { "target": "com.amazonaws.amplify#EnablePerformanceMode", "traits": { - "smithy.api#documentation": "

Enables performance mode for the branch.

\n

Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.

" + "smithy.api#documentation": "

Enables performance mode for the branch.

\n

Performance mode optimizes for faster hosting performance by keeping content cached at\n the edge for a longer interval. When performance mode is enabled, hosting configuration\n or code changes can take up to 10 minutes to roll out.

" } }, "tags": { @@ -1632,9 +1651,10 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 1, + "min": 0, "max": 25000 - } + }, + "smithy.api#pattern": "^(?s)" } }, "com.amazonaws.amplify#CustomRule": { @@ -1657,7 +1677,7 @@ "status": { "target": "com.amazonaws.amplify#Status", "traits": { - "smithy.api#documentation": "

The status code for a URL rewrite or redirect rule.

\n \n
\n
200
\n
\n

Represents a 200 rewrite rule.

\n
\n
301
\n
\n

Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL.

\n
\n
302
\n
\n

Represents a 302 temporary redirect rule.

\n
\n
404
\n
\n

Represents a 404 redirect rule.

\n
\n
404-200
\n
\n

Represents a 404 rewrite rule.

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

The status code for a URL rewrite or redirect rule.

\n\n
\n
200
\n
\n

Represents a 200 rewrite rule.

\n
\n
301
\n
\n

Represents a 301 (moved pemanently) redirect rule. This and all future\n requests should be directed to the target URL.

\n
\n
302
\n
\n

Represents a 302 temporary redirect rule.

\n
\n
404
\n
\n

Represents a 404 redirect rule.

\n
\n
404-200
\n
\n

Represents a 404 rewrite rule.

\n
\n
" } }, "condition": { @@ -2138,7 +2158,8 @@ "smithy.api#length": { "min": 1, "max": 1000 - } + }, + "smithy.api#pattern": "^(?s).+$" } }, "com.amazonaws.amplify#Description": { @@ -2147,7 +2168,8 @@ "smithy.api#length": { "min": 0, "max": 1000 - } + }, + "smithy.api#pattern": "^(?s)" } }, "com.amazonaws.amplify#DisplayName": { @@ -2156,7 +2178,8 @@ "smithy.api#length": { "min": 0, "max": 255 - } + }, + "smithy.api#pattern": "^(?s)" } }, "com.amazonaws.amplify#DomainAssociation": { @@ -2253,8 +2276,9 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 255 - } + "max": 64 + }, + "smithy.api#pattern": "^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])(\\.)?$" } }, "com.amazonaws.amplify#DomainPrefix": { @@ -2263,7 +2287,8 @@ "smithy.api#length": { "min": 0, "max": 255 - } + }, + "smithy.api#pattern": "^(?s)" } }, "com.amazonaws.amplify#DomainStatus": { @@ -2368,7 +2393,8 @@ "smithy.api#length": { "min": 0, "max": 255 - } + }, + "smithy.api#pattern": "^(?s)" } }, "com.amazonaws.amplify#EnvValue": { @@ -2376,8 +2402,9 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 1000 - } + "max": 5500 + }, + "smithy.api#pattern": "^(?s)" } }, "com.amazonaws.amplify#EnvironmentName": { @@ -2386,7 +2413,8 @@ "smithy.api#length": { "min": 1, "max": 255 - } + }, + "smithy.api#pattern": "^(?s).+$" } }, "com.amazonaws.amplify#EnvironmentVariables": { @@ -2422,7 +2450,8 @@ "smithy.api#length": { "min": 0, "max": 255 - } + }, + "smithy.api#pattern": "^(?s)" } }, "com.amazonaws.amplify#FileUploadUrls": { @@ -2440,7 +2469,8 @@ "smithy.api#length": { "min": 0, "max": 255 - } + }, + "smithy.api#pattern": "^(?s)" } }, "com.amazonaws.amplify#GenerateAccessLogs": { @@ -3051,7 +3081,8 @@ "smithy.api#length": { "min": 0, "max": 255 - } + }, + "smithy.api#pattern": "^[0-9]+$" } }, "com.amazonaws.amplify#JobReason": { @@ -3060,7 +3091,8 @@ "smithy.api#length": { "min": 0, "max": 255 - } + }, + "smithy.api#pattern": "^(?s)" } }, "com.amazonaws.amplify#JobStatus": { @@ -3875,7 +3907,8 @@ "smithy.api#length": { "min": 0, "max": 32 - } + }, + "smithy.api#pattern": "^(?s)" } }, "com.amazonaws.amplify#MaxResults": { @@ -3893,7 +3926,8 @@ "smithy.api#length": { "min": 1, "max": 255 - } + }, + "smithy.api#pattern": "^(?s).+$" } }, "com.amazonaws.amplify#NextToken": { @@ -3902,7 +3936,8 @@ "smithy.api#length": { "min": 0, "max": 2000 - } + }, + "smithy.api#pattern": "^(?s)" } }, "com.amazonaws.amplify#NotFoundException": { @@ -3925,6 +3960,7 @@ "min": 0, "max": 1000 }, + "smithy.api#pattern": "^(?s)", "smithy.api#sensitive": {} } }, @@ -3935,6 +3971,10 @@ { "value": "WEB", "name": "WEB" + }, + { + "value": "WEB_DYNAMIC", + "name": "WEB_DYNAMIC" } ] } @@ -3977,7 +4017,8 @@ "smithy.api#length": { "min": 0, "max": 20 - } + }, + "smithy.api#pattern": "^(?s)" } }, "com.amazonaws.amplify#Repository": { @@ -3986,12 +4027,36 @@ "smithy.api#length": { "min": 0, "max": 1000 - } + }, + "smithy.api#pattern": "^(?s)" + } + }, + "com.amazonaws.amplify#RepositoryCloneMethod": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SSH", + "name": "SSH" + }, + { + "value": "TOKEN", + "name": "TOKEN" + }, + { + "value": "SIGV4", + "name": "SIGV4" + } + ] } }, "com.amazonaws.amplify#ResourceArn": { "type": "string", "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, "smithy.api#pattern": "^arn:aws:amplify:" } }, @@ -4030,9 +4095,10 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 1, + "min": 0, "max": 1000 - } + }, + "smithy.api#pattern": "^(?s)" } }, "com.amazonaws.amplify#Source": { @@ -4041,7 +4107,8 @@ "smithy.api#length": { "min": 1, "max": 2048 - } + }, + "smithy.api#pattern": "^(?s).+$" } }, "com.amazonaws.amplify#SourceUrl": { @@ -4049,8 +4116,9 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 1000 - } + "max": 3000 + }, + "smithy.api#pattern": "^(?s)" } }, "com.amazonaws.amplify#StackName": { @@ -4059,7 +4127,8 @@ "smithy.api#length": { "min": 1, "max": 255 - } + }, + "smithy.api#pattern": "^(?s).+$" } }, "com.amazonaws.amplify#Stage": { @@ -4293,7 +4362,8 @@ "smithy.api#length": { "min": 3, "max": 7 - } + }, + "smithy.api#pattern": "^.{3,7}$" } }, "com.amazonaws.amplify#StatusReason": { @@ -4557,7 +4627,12 @@ "com.amazonaws.amplify#TTL": { "type": "string", "traits": { - "smithy.api#documentation": "

The content Time to Live (TTL) for the website in seconds.

" + "smithy.api#documentation": "

The content Time to Live (TTL) for the website in seconds.

", + "smithy.api#length": { + "min": 0, + "max": 32 + }, + "smithy.api#pattern": "^\\d*$" } }, "com.amazonaws.amplify#TagKey": { @@ -4592,7 +4667,7 @@ }, "traits": { "smithy.api#length": { - "min": 1, + "min": 0, "max": 50 } } @@ -4661,7 +4736,8 @@ "smithy.api#length": { "min": 0, "max": 256 - } + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.amplify#Target": { @@ -4670,7 +4746,8 @@ "smithy.api#length": { "min": 1, "max": 2048 - } + }, + "smithy.api#pattern": "^(?s).+$" } }, "com.amazonaws.amplify#TestArtifactsUrl": { @@ -4883,7 +4960,7 @@ "basicAuthCredentials": { "target": "com.amazonaws.amplify#BasicAuthCredentials", "traits": { - "smithy.api#documentation": "

The basic authorization credentials for an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.

" + "smithy.api#documentation": "

The basic authorization credentials for an Amplify app. You must base64-encode the\n authorization credentials and provide them in the format\n user:password.

" } }, "customRules": { @@ -5052,7 +5129,7 @@ "basicAuthCredentials": { "target": "com.amazonaws.amplify#BasicAuthCredentials", "traits": { - "smithy.api#documentation": "

The basic authorization credentials for the branch. You must base64-encode the authorization credentials and provide them in the format user:password.

" + "smithy.api#documentation": "

The basic authorization credentials for the branch. You must base64-encode the\n authorization credentials and provide them in the format\n user:password.

" } }, "enableBasicAuth": { @@ -5064,7 +5141,7 @@ "enablePerformanceMode": { "target": "com.amazonaws.amplify#EnablePerformanceMode", "traits": { - "smithy.api#documentation": "

Enables performance mode for the branch.

\n

Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.

" + "smithy.api#documentation": "

Enables performance mode for the branch.

\n

Performance mode optimizes for faster hosting performance by keeping content cached at\n the edge for a longer interval. When performance mode is enabled, hosting configuration\n or code changes can take up to 10 minutes to roll out.

" } }, "buildSpec": { @@ -5185,8 +5262,7 @@ "subDomainSettings": { "target": "com.amazonaws.amplify#SubDomainSettings", "traits": { - "smithy.api#documentation": "

Describes the settings for the subdomain.

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

Describes the settings for the subdomain.

" } }, "autoSubDomainCreationPatterns": { @@ -5388,7 +5464,8 @@ "smithy.api#length": { "min": 0, "max": 255 - } + }, + "smithy.api#pattern": "^(?s)" } }, "com.amazonaws.amplify#WebhookUrl": { diff --git a/aws/sdk/aws-models/amplifyuibuilder.json b/aws/sdk/aws-models/amplifyuibuilder.json index 9b80275040..4fb52c3dce 100644 --- a/aws/sdk/aws-models/amplifyuibuilder.json +++ b/aws/sdk/aws-models/amplifyuibuilder.json @@ -1,6 +1,68 @@ { "smithy": "1.0", "shapes": { + "com.amazonaws.amplifyuibuilder#ActionParameters": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.amplifyuibuilder#ComponentProperty", + "traits": { + "smithy.api#documentation": "

The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.

" + } + }, + "url": { + "target": "com.amazonaws.amplifyuibuilder#ComponentProperty", + "traits": { + "smithy.api#documentation": "

The URL to the location to open. Specify this value for a navigation action.

" + } + }, + "anchor": { + "target": "com.amazonaws.amplifyuibuilder#ComponentProperty", + "traits": { + "smithy.api#documentation": "

The HTML anchor link to the location to open. Specify this value for a navigation action.

" + } + }, + "target": { + "target": "com.amazonaws.amplifyuibuilder#ComponentProperty", + "traits": { + "smithy.api#documentation": "

The element within the same component to modify when the action occurs.

" + } + }, + "global": { + "target": "com.amazonaws.amplifyuibuilder#ComponentProperty", + "traits": { + "smithy.api#documentation": "

Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.

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

The name of the data model. Use when the action performs an operation on an Amplify DataStore\n model.

" + } + }, + "id": { + "target": "com.amazonaws.amplifyuibuilder#ComponentProperty", + "traits": { + "smithy.api#documentation": "

The unique ID of the component that the ActionParameters apply to.

" + } + }, + "fields": { + "target": "com.amazonaws.amplifyuibuilder#ComponentProperties", + "traits": { + "smithy.api#documentation": "

A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action\n performs an operation on an Amplify DataStore model.

" + } + }, + "state": { + "target": "com.amazonaws.amplifyuibuilder#MutationActionSetStateParameter", + "traits": { + "smithy.api#documentation": "

A key-value pair that specifies the state property name and its initial value.

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

Represents the event action configuration for an element of a Component\n or ComponentChild. Use for the workflow feature in Amplify Studio\n that allows you to bind events and actions to components. ActionParameters\n defines the action that is performed when an event occurs on the component.

" + } + }, "com.amazonaws.amplifyuibuilder#AmplifyUIBuilder": { "type": "service", "traits": { @@ -8,15 +70,14 @@ "sdkId": "AmplifyUIBuilder", "arnNamespace": "amplifyuibuilder", "cloudFormationName": "AmplifyUIBuilder", - "cloudTrailEventSource": "amplifyuibuilder.amazonaws.com", - "endpointPrefix": "amplifyuibuilder" + "cloudTrailEventSource": "amplifyuibuilder.amazonaws.com" }, "aws.auth#sigv4": { "name": "amplifyuibuilder" }, "aws.protocols#restJson1": {}, "smithy.api#cors": {}, - "smithy.api#documentation": "

The Amplify UI Builder API provides a programmatic interface for creating and configuring\n user interface (UI) component libraries and themes for use in your Amplify applications. You\n can then connect these UI components to an application's backend Amazon Web Services\n resources.

\n

You can also use the Amplify Studio visual designer to create UI components and model data\n for an app. For more information, see Introduction in the\n Amplify Docs.

\n

The Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation\n for client app development. For more information, see the Amplify Framework. For more information about\n deploying an Amplify application to Amazon Web Services, see the Amplify Console User Guide.

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

The Amplify UI Builder API provides a programmatic interface for creating\n and configuring user interface (UI) component libraries and themes for use in your Amplify applications. You can then connect these UI components to an application's\n backend Amazon Web Services resources.

\n

You can also use the Amplify Studio visual designer to create UI components\n and model data for an app. For more information, see Introduction in the\n Amplify Docs.

\n

The Amplify Framework is a comprehensive set of SDKs, libraries, tools, and\n documentation for client app development. For more information, see the Amplify Framework. For more information about\n deploying an Amplify application to Amazon Web Services, see the Amplify User Guide.

", "smithy.api#title": "AWS Amplify UI Builder" }, "version": "2021-08-11", @@ -50,7 +111,7 @@ "environmentName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The name of the backend environment that is a part of the Amplify app.

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

The name of the backend environment that is a part of the Amplify\n app.

", "smithy.api#required": {} } }, @@ -77,14 +138,14 @@ "componentType": { "target": "com.amazonaws.amplifyuibuilder#ComponentType", "traits": { - "smithy.api#documentation": "

The type of the component. This can be an Amplify custom UI component or another custom\n component.

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

The type of the component. This can be an Amplify custom UI component or\n another custom component.

", "smithy.api#required": {} } }, "properties": { "target": "com.amazonaws.amplifyuibuilder#ComponentProperties", "traits": { - "smithy.api#documentation": "

Describes the component's properties.

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

Describes the component's properties. You can't specify tags as a valid\n property for properties.

", "smithy.api#required": {} } }, @@ -97,34 +158,34 @@ "variants": { "target": "com.amazonaws.amplifyuibuilder#ComponentVariants", "traits": { - "smithy.api#documentation": "

A list of the component's variants. A variant is a unique style configuration of a\n main component.

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

A list of the component's variants. A variant is a unique style configuration of a main\n component.

", "smithy.api#required": {} } }, "overrides": { "target": "com.amazonaws.amplifyuibuilder#ComponentOverrides", "traits": { - "smithy.api#documentation": "

Describes the component's properties that can be overriden in a customized instance of the\n component.

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

Describes the component's properties that can be overriden in a customized instance of the\n component. You can't specify tags as a valid property for\n overrides.

", "smithy.api#required": {} } }, "bindingProperties": { "target": "com.amazonaws.amplifyuibuilder#ComponentBindingProperties", "traits": { - "smithy.api#documentation": "

The information to connect a component's properties to data at runtime.

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

The information to connect a component's properties to data at runtime. You can't specify\n tags as a valid property for bindingProperties.

\n

", "smithy.api#required": {} } }, "collectionProperties": { "target": "com.amazonaws.amplifyuibuilder#ComponentCollectionProperties", "traits": { - "smithy.api#documentation": "

The data binding configuration for the component's properties. Use this for a collection component.

" + "smithy.api#documentation": "

The data binding configuration for the component's properties. Use this for a collection\n component. You can't specify tags as a valid property for\n collectionProperties.

" } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { - "aws.cloudformation#cfnMutability": "read", + "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

The time that the component was created.

", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" @@ -133,7 +194,7 @@ "modifiedAt": { "target": "smithy.api#Timestamp", "traits": { - "aws.cloudformation#cfnMutability": "read", + "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

The time that the component was modified.

", "smithy.api#timestampFormat": "date-time" } @@ -144,10 +205,22 @@ "aws.cloudformation#cfnMutability": "create-and-read", "smithy.api#documentation": "

One or more key-value pairs to use when tagging the component.

" } + }, + "events": { + "target": "com.amazonaws.amplifyuibuilder#ComponentEvents", + "traits": { + "smithy.api#documentation": "

Describes the events that can be raised on the component. Use for the workflow feature in Amplify Studio that allows you to\n bind events and actions to components.

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

The schema version of the component when it was imported.

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

Contains the configuration settings for a user interface (UI) element for an Amplify app. A\n component is configured as a primary, stand-alone UI element. Use ComponentChild\n to configure an instance of a Component. A ComponentChild instance\n inherits the configuration of the main Component.

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

Contains the configuration settings for a user interface (UI) element for an Amplify app. A component is configured as a primary, stand-alone UI element. Use\n ComponentChild to configure an instance of a Component. A\n ComponentChild instance inherits the configuration of the main\n Component.

", "smithy.api#references": [ { "resource": "com.amazonaws.amplifyuibuilder#ComponentResource" @@ -260,7 +333,7 @@ "properties": { "target": "com.amazonaws.amplifyuibuilder#ComponentProperties", "traits": { - "smithy.api#documentation": "

Describes the properties of the child component.

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

Describes the properties of the child component. You can't specify tags as a\n valid property for properties.

", "smithy.api#required": {} } }, @@ -269,6 +342,12 @@ "traits": { "smithy.api#documentation": "

The list of ComponentChild instances for this component.

" } + }, + "events": { + "target": "com.amazonaws.amplifyuibuilder#ComponentEvents", + "traits": { + "smithy.api#documentation": "

Describes the events that can be raised on the child component. Use for the workflow feature in Amplify Studio that allows you to\n bind events and actions to components.

" + } } }, "traits": { @@ -328,6 +407,12 @@ "traits": { "smithy.api#documentation": "

The value to assign to the property if the condition is not met.

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

The type of the property to evaluate.

" + } } }, "traits": { @@ -367,6 +452,35 @@ "smithy.api#documentation": "

Describes the configuration for binding a component's properties to data.

" } }, + "com.amazonaws.amplifyuibuilder#ComponentEvent": { + "type": "structure", + "members": { + "action": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The action to perform when a specific event is raised.

" + } + }, + "parameters": { + "target": "com.amazonaws.amplifyuibuilder#ActionParameters", + "traits": { + "smithy.api#documentation": "

Describes information about the action.

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

Describes the configuration of an event. You can bind an event and a corresponding\n action to a Component or a ComponentChild. A button click\n is an example of an event.

" + } + }, + "com.amazonaws.amplifyuibuilder#ComponentEvents": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "com.amazonaws.amplifyuibuilder#ComponentEvent" + } + }, "com.amazonaws.amplifyuibuilder#ComponentList": { "type": "list", "member": { @@ -427,7 +541,7 @@ "collectionBindingProperties": { "target": "com.amazonaws.amplifyuibuilder#ComponentPropertyBindingProperties", "traits": { - "smithy.api#documentation": "

The information to bind the component property to data at runtime. Use this for collection components.

" + "smithy.api#documentation": "

The information to bind the component property to data at runtime. Use this for collection\n components.

" } }, "defaultValue": { @@ -463,19 +577,19 @@ "concat": { "target": "com.amazonaws.amplifyuibuilder#ComponentPropertyList", "traits": { - "smithy.api#documentation": "

A list of component properties to concatenate to create the value to assign to this component property.

" + "smithy.api#documentation": "

A list of component properties to concatenate to create the value to assign to this\n component property.

" } }, "condition": { "target": "com.amazonaws.amplifyuibuilder#ComponentConditionProperty", "traits": { - "smithy.api#documentation": "

The conditional expression to use to assign a value to the component property..

" + "smithy.api#documentation": "

The conditional expression to use to assign a value to the component property.

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

Specifies whether the user configured the property in Amplify Studio after importing it.

" + "smithy.api#documentation": "

Specifies whether the user configured the property in Amplify Studio after\n importing it.

" } }, "type": { @@ -487,12 +601,24 @@ "importedValue": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The default value assigned to property when the component is imported into an app.

" + "smithy.api#documentation": "

The default value assigned to the property when the component is imported into an\n app.

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

The name of the component that is affected by an event.

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

The name of the component's property that is affected by an event.

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

Describes the configuration for all of a component's properties. Use\n ComponentProperty to specify the values to render or bind by\n default.

" + "smithy.api#documentation": "

Describes the configuration for all of a component's properties. Use\n ComponentProperty to specify the values to render or bind by default.

" } }, "com.amazonaws.amplifyuibuilder#ComponentPropertyBindingProperties": { @@ -557,16 +683,13 @@ ], "traits": { "aws.api#arn": { - "template": "app/{appId}/environment/{environmentName}/components/{id}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "app/{appId}/environment/{environmentName}/components/{id}" }, "aws.cloudformation#cfnResource": { + "name": "Component", "additionalSchemas": [ "com.amazonaws.amplifyuibuilder#Component" - ], - "name": "Component" + ] } } }, @@ -583,7 +706,7 @@ "environmentName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The name of the backend environment that is a part of the Amplify app.

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

The name of the backend environment that is a part of the Amplify\n app.

", "smithy.api#required": {} } }, @@ -634,13 +757,13 @@ "variantValues": { "target": "com.amazonaws.amplifyuibuilder#ComponentVariantValues", "traits": { - "smithy.api#documentation": "

The combination of variants that comprise this variant.

" + "smithy.api#documentation": "

The combination of variants that comprise this variant. You can't specify\n tags as a valid property for variantValues.

" } }, "overrides": { "target": "com.amazonaws.amplifyuibuilder#ComponentOverrides", "traits": { - "smithy.api#documentation": "

The properties of the component variant that can be overriden when customizing an instance\n of the component.

" + "smithy.api#documentation": "

The properties of the component variant that can be overriden when customizing an instance\n of the component. You can't specify tags as a valid property for\n overrides.

" } } }, @@ -686,11 +809,13 @@ } ], "traits": { + "aws.iam#requiredActions": [ + "amplify:GetApp" + ], "smithy.api#documentation": "

Creates a new component for an Amplify app.

", "smithy.api#http": { - "method": "POST", "uri": "/app/{appId}/environment/{environmentName}/components", - "code": 200 + "method": "POST" }, "smithy.api#idempotent": {} } @@ -714,7 +839,7 @@ "componentType": { "target": "com.amazonaws.amplifyuibuilder#ComponentType", "traits": { - "smithy.api#documentation": "

The component type. This can be an Amplify custom UI component or another custom\n component.

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

The component type. This can be an Amplify custom UI component or another\n custom component.

", "smithy.api#required": {} } }, @@ -755,7 +880,7 @@ "collectionProperties": { "target": "com.amazonaws.amplifyuibuilder#ComponentCollectionProperties", "traits": { - "smithy.api#documentation": "

The data binding configuration for customizing a component's properties. Use this for a collection component.

" + "smithy.api#documentation": "

The data binding configuration for customizing a component's properties. Use this for a\n collection component.

" } }, "tags": { @@ -763,6 +888,18 @@ "traits": { "smithy.api#documentation": "

One or more key-value pairs to use when tagging the component data.

" } + }, + "events": { + "target": "com.amazonaws.amplifyuibuilder#ComponentEvents", + "traits": { + "smithy.api#documentation": "

The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.

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

The schema version of the component when it was imported.

" + } } }, "traits": { @@ -783,7 +920,7 @@ "environmentName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The name of the backend environment that is a part of the Amplify app.

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

The name of the backend environment that is a part of the Amplify\n app.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -843,11 +980,13 @@ } ], "traits": { + "aws.iam#requiredActions": [ + "amplify:GetApp" + ], "smithy.api#documentation": "

Creates a theme to apply to the components in an Amplify app.

", "smithy.api#http": { - "method": "POST", "uri": "/app/{appId}/environment/{environmentName}/themes", - "code": 200 + "method": "POST" }, "smithy.api#idempotent": {} } @@ -900,7 +1039,7 @@ "environmentName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The name of the backend environment that is a part of the Amplify app.

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

The name of the backend environment that is a part of the Amplify\n app.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -942,6 +1081,9 @@ "input": { "target": "com.amazonaws.amplifyuibuilder#DeleteComponentRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.amplifyuibuilder#InternalServerException" @@ -954,11 +1096,13 @@ } ], "traits": { + "aws.iam#requiredActions": [ + "amplify:GetApp" + ], "smithy.api#documentation": "

Deletes a component from an Amplify app.

", "smithy.api#http": { - "method": "DELETE", "uri": "/app/{appId}/environment/{environmentName}/components/{id}", - "code": 200 + "method": "DELETE" }, "smithy.api#idempotent": {} } @@ -969,7 +1113,7 @@ "appId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The unique ID of the Amplify app associated with the component to delete.

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

The unique ID of the Amplify app associated with the component to\n delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -977,7 +1121,7 @@ "environmentName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The name of the backend environment that is a part of the Amplify app.

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

The name of the backend environment that is a part of the Amplify\n app.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -997,6 +1141,9 @@ "input": { "target": "com.amazonaws.amplifyuibuilder#DeleteThemeRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.amplifyuibuilder#InternalServerException" @@ -1009,11 +1156,13 @@ } ], "traits": { + "aws.iam#requiredActions": [ + "amplify:GetApp" + ], "smithy.api#documentation": "

Deletes a theme from an Amplify app.

", "smithy.api#http": { - "method": "DELETE", "uri": "/app/{appId}/environment/{environmentName}/themes/{id}", - "code": 200 + "method": "DELETE" }, "smithy.api#idempotent": {} } @@ -1024,7 +1173,7 @@ "appId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The unique ID of the Amplify app associated with the theme to delete.

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

The unique ID of the Amplify app associated with the theme to\n delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1032,7 +1181,7 @@ "environmentName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The name of the backend environment that is a part of the Amplify app.

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

The name of the backend environment that is a part of the Amplify\n app.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1063,9 +1212,8 @@ "traits": { "smithy.api#documentation": "

Exchanges an access code for a token.

", "smithy.api#http": { - "method": "POST", "uri": "/tokens/{provider}", - "code": 200 + "method": "POST" } } }, @@ -1158,11 +1306,15 @@ } ], "traits": { - "smithy.api#documentation": "

Exports component configurations to code that is ready to integrate into an Amplify\n app.

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

Exports component configurations to code that is ready to integrate into an Amplify app.

", "smithy.api#http": { - "method": "GET", "uri": "/export/app/{appId}/environment/{environmentName}/components", - "code": 200 + "method": "GET" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "entities" }, "smithy.api#readonly": {} } @@ -1181,10 +1333,17 @@ "environmentName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The name of the backend environment that is a part of the Amplify app.

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

The name of the backend environment that is a part of the Amplify\n app.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The token to request the next page of results.

", + "smithy.api#httpQuery": "nextToken" + } } } }, @@ -1197,6 +1356,12 @@ "smithy.api#documentation": "

Represents the configuration of the exported components.

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

The pagination token that's included if more results are available.

" + } } } }, @@ -1217,11 +1382,15 @@ } ], "traits": { - "smithy.api#documentation": "

Exports theme configurations to code that is ready to integrate into an Amplify\n app.

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

Exports theme configurations to code that is ready to integrate into an Amplify app.

", "smithy.api#http": { - "method": "GET", "uri": "/export/app/{appId}/environment/{environmentName}/themes", - "code": 200 + "method": "GET" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "entities" }, "smithy.api#readonly": {} } @@ -1244,6 +1413,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The token to request the next page of results.

", + "smithy.api#httpQuery": "nextToken" + } } } }, @@ -1256,6 +1432,12 @@ "smithy.api#documentation": "

Represents the configuration of the exported themes.

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

The pagination token that's included if more results are available.

" + } } } }, @@ -1310,11 +1492,13 @@ } ], "traits": { + "aws.iam#requiredActions": [ + "amplify:GetApp" + ], "smithy.api#documentation": "

Returns an existing component for an Amplify app.

", "smithy.api#http": { - "method": "GET", "uri": "/app/{appId}/environment/{environmentName}/components/{id}", - "code": 200 + "method": "GET" }, "smithy.api#readonly": {} } @@ -1381,11 +1565,13 @@ } ], "traits": { + "aws.iam#requiredActions": [ + "amplify:GetApp" + ], "smithy.api#documentation": "

Returns an existing theme for an Amplify app.

", "smithy.api#http": { - "method": "GET", "uri": "/app/{appId}/environment/{environmentName}/themes/{id}", - "code": 200 + "method": "GET" }, "smithy.api#readonly": {} } @@ -1481,17 +1667,19 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves a list of components for a specified Amplify app and backend environment.

", + "aws.iam#requiredActions": [ + "amplify:GetApp" + ], + "smithy.api#documentation": "

Retrieves a list of components for a specified Amplify app and backend\n environment.

", "smithy.api#http": { - "method": "GET", "uri": "/app/{appId}/environment/{environmentName}/components", - "code": 200 + "method": "GET" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "entities", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "entities" }, "smithy.api#readonly": {} } @@ -1519,7 +1707,7 @@ "environmentName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The name of the backend environment that is a part of the Amplify app.

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

The name of the backend environment that is a part of the Amplify\n app.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1575,17 +1763,19 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves a list of themes for a specified Amplify app and backend environment.

", + "aws.iam#requiredActions": [ + "amplify:GetApp" + ], + "smithy.api#documentation": "

Retrieves a list of themes for a specified Amplify app and backend\n environment.

", "smithy.api#http": { - "method": "GET", "uri": "/app/{appId}/environment/{environmentName}/themes", - "code": 200 + "method": "GET" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "entities", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "entities" }, "smithy.api#readonly": {} } @@ -1613,7 +1803,7 @@ "environmentName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The name of the backend environment that is a part of the Amplify app.

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

The name of the backend environment that is a part of the Amplify\n app.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1652,6 +1842,35 @@ } } }, + "com.amazonaws.amplifyuibuilder#MutationActionSetStateParameter": { + "type": "structure", + "members": { + "componentName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the component that is being modified.

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

The name of the component property to apply the state configuration to.

", + "smithy.api#required": {} + } + }, + "set": { + "target": "com.amazonaws.amplifyuibuilder#ComponentProperty", + "traits": { + "smithy.api#documentation": "

The state configuration to assign to the property.

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

Represents the state configuration when an action modifies a property of another\n element within the same component.

" + } + }, "com.amazonaws.amplifyuibuilder#Predicate": { "type": "structure", "members": { @@ -1687,7 +1906,7 @@ } }, "traits": { - "smithy.api#documentation": "

Stores information for generating Amplify DataStore queries. Use a Predicate\n to retrieve a subset of the data in a collection.

" + "smithy.api#documentation": "

Stores information for generating Amplify DataStore queries. Use a\n Predicate to retrieve a subset of the data in a collection.

" } }, "com.amazonaws.amplifyuibuilder#PredicateList": { @@ -1712,9 +1931,8 @@ "traits": { "smithy.api#documentation": "

Refreshes a previously issued access token that might have expired.

", "smithy.api#http": { - "method": "POST", "uri": "/tokens/{provider}/refresh", - "code": 200 + "method": "POST" } } }, @@ -1896,7 +2114,7 @@ "environmentName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The name of the backend environment that is a part of the Amplify app.

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

The name of the backend environment that is a part of the Amplify\n app.

", "smithy.api#required": {} } }, @@ -1917,7 +2135,7 @@ "createdAt": { "target": "smithy.api#Timestamp", "traits": { - "aws.cloudformation#cfnMutability": "read", + "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

The time that the theme was created.

", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" @@ -1926,7 +2144,7 @@ "modifiedAt": { "target": "smithy.api#Timestamp", "traits": { - "aws.cloudformation#cfnMutability": "read", + "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

The time that the theme was modified.

", "smithy.api#timestampFormat": "date-time" } @@ -2011,16 +2229,13 @@ ], "traits": { "aws.api#arn": { - "template": "app/{appId}/environment/{environmentName}/themes/{id}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "app/{appId}/environment/{environmentName}/themes/{id}" }, "aws.cloudformation#cfnResource": { + "name": "Theme", "additionalSchemas": [ "com.amazonaws.amplifyuibuilder#Theme" - ], - "name": "Theme" + ] } } }, @@ -2144,11 +2359,13 @@ } ], "traits": { + "aws.iam#requiredActions": [ + "amplify:GetApp" + ], "smithy.api#documentation": "

Updates an existing component.

", "smithy.api#http": { - "method": "PATCH", "uri": "/app/{appId}/environment/{environmentName}/components/{id}", - "code": 200 + "method": "PATCH" }, "smithy.api#idempotent": {} } @@ -2177,7 +2394,7 @@ "componentType": { "target": "com.amazonaws.amplifyuibuilder#ComponentType", "traits": { - "smithy.api#documentation": "

The type of the component. This can be an Amplify custom UI component or another custom\n component.

" + "smithy.api#documentation": "

The type of the component. This can be an Amplify custom UI component or\n another custom component.

" } }, "properties": { @@ -2213,7 +2430,19 @@ "collectionProperties": { "target": "com.amazonaws.amplifyuibuilder#ComponentCollectionProperties", "traits": { - "smithy.api#documentation": "

The configuration for binding a component's properties to a data model. Use this for a collection component.

" + "smithy.api#documentation": "

The configuration for binding a component's properties to a data model. Use this for a\n collection component.

" + } + }, + "events": { + "target": "com.amazonaws.amplifyuibuilder#ComponentEvents", + "traits": { + "smithy.api#documentation": "

The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.

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

The schema version of the component when it was imported.

" } } }, @@ -2300,11 +2529,13 @@ } ], "traits": { + "aws.iam#requiredActions": [ + "amplify:GetApp" + ], "smithy.api#documentation": "

Updates an existing theme.

", "smithy.api#http": { - "method": "PATCH", "uri": "/app/{appId}/environment/{environmentName}/themes/{id}", - "code": 200 + "method": "PATCH" }, "smithy.api#idempotent": {} } diff --git a/aws/sdk/aws-models/appflow.json b/aws/sdk/aws-models/appflow.json index 27ef6fb519..1ea5b90c8d 100644 --- a/aws/sdk/aws-models/appflow.json +++ b/aws/sdk/aws-models/appflow.json @@ -3173,6 +3173,12 @@ "smithy.api#documentation": "

The properties required to query Zendesk.

" } }, + "Marketo": { + "target": "com.amazonaws.appflow#MarketoDestinationProperties", + "traits": { + "smithy.api#documentation": "

The properties required to query Marketo.

" + } + }, "CustomConnector": { "target": "com.amazonaws.appflow#CustomConnectorDestinationProperties", "traits": { @@ -4750,6 +4756,24 @@ "smithy.api#documentation": "

The connector-specific profile properties required when using Marketo.

" } }, + "com.amazonaws.appflow#MarketoDestinationProperties": { + "type": "structure", + "members": { + "object": { + "target": "com.amazonaws.appflow#Object", + "traits": { + "smithy.api#documentation": "

The object specified in the Marketo flow destination.

", + "smithy.api#required": {} + } + }, + "errorHandlingConfig": { + "target": "com.amazonaws.appflow#ErrorHandlingConfig" + } + }, + "traits": { + "smithy.api#documentation": "

The properties that Amazon AppFlow applies when you use Marketo as a flow destination.

" + } + }, "com.amazonaws.appflow#MarketoMetadata": { "type": "structure", "members": {}, diff --git a/aws/sdk/aws-models/athena.json b/aws/sdk/aws-models/athena.json index 74c5ded157..5a24124b64 100644 --- a/aws/sdk/aws-models/athena.json +++ b/aws/sdk/aws-models/athena.json @@ -29,6 +29,21 @@ ] }, "shapes": { + "com.amazonaws.athena#AclConfiguration": { + "type": "structure", + "members": { + "S3AclOption": { + "target": "com.amazonaws.athena#S3AclOption", + "traits": { + "smithy.api#documentation": "

The Amazon S3 canned ACL that Athena should specify when storing\n query results. Currently the only supported canned ACL is\n BUCKET_OWNER_FULL_CONTROL. If a query runs in a workgroup and the\n workgroup overrides client-side settings, then the Amazon S3 canned ACL\n specified in the workgroup's settings is used for all queries that run in the workgroup.\n For more information about Amazon S3 canned ACLs, see Canned ACL in the Amazon S3 User\n Guide.

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

Indicates that an Amazon S3 canned ACL should be set to control ownership of\n stored query results. When Athena stores query results in Amazon S3,\n the canned ACL is set with the x-amz-acl request header. For more\n information about S3 Object Ownership, see Object Ownership settings in the Amazon S3 User\n Guide.

" + } + }, "com.amazonaws.athena#AmazonAthena": { "type": "service", "traits": { @@ -144,6 +159,9 @@ { "target": "com.amazonaws.athena#UpdateDataCatalog" }, + { + "target": "com.amazonaws.athena#UpdateNamedQuery" + }, { "target": "com.amazonaws.athena#UpdatePreparedStatement" }, @@ -167,7 +185,7 @@ "ErrorCategory": { "target": "com.amazonaws.athena#ErrorCategory", "traits": { - "smithy.api#documentation": "

An integer value that specifies the category of a query failure error. The following\n list shows the category for each integer value.

\n

\n 1 - System

\n

\n 2 - User

\n

\n 3 - Unknown

" + "smithy.api#documentation": "

An integer value that specifies the category of a query failure error. The following\n list shows the category for each integer value.

\n

\n 1 - System

\n

\n 2 - User

\n

\n 3 - Other

" } }, "ErrorType": { @@ -178,7 +196,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides information about an Athena query error. The\n AthenaError feature provides standardized error information to help you\n understand failed queries and take steps after a query failure occurs.\n AthenaError includes an ErrorCategory field that specifies\n whether the cause of the failed query is due to system error, user error, or unknown\n error.

" + "smithy.api#documentation": "

Provides information about an Athena query error. The\n AthenaError feature provides standardized error information to help you\n understand failed queries and take steps after a query failure occurs.\n AthenaError includes an ErrorCategory field that specifies\n whether the cause of the failed query is due to system error, user error, or other\n error.

" } }, "com.amazonaws.athena#BatchGetNamedQuery": { @@ -2320,7 +2338,7 @@ "QueryString": { "target": "com.amazonaws.athena#QueryString", "traits": { - "smithy.api#documentation": "

The SQL query statements that comprise the query.

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

The SQL statements that make up the query.

", "smithy.api#required": {} } }, @@ -2338,7 +2356,16 @@ } }, "traits": { - "smithy.api#documentation": "

A query, where QueryString is the list of SQL query statements that\n comprise the query.

" + "smithy.api#documentation": "

A query, where QueryString contains the SQL statements that\n make up the query.

" + } + }, + "com.amazonaws.athena#NamedQueryDescriptionString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } } }, "com.amazonaws.athena#NamedQueryId": { @@ -2712,6 +2739,12 @@ "traits": { "smithy.api#documentation": "

The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by ResultConfiguration$OutputLocation.\n If set, Athena uses the value for ExpectedBucketOwner when it\n makes Amazon S3 calls to your specified output location. If the\n ExpectedBucketOwner\n Amazon Web Services account ID does not match the actual owner of the Amazon S3\n bucket, the call fails with a permissions error.

\n

This is a client-side setting. If workgroup settings override client-side settings,\n then the query uses the ExpectedBucketOwner setting that is specified for\n the workgroup, and also uses the location for storing query results specified in the\n workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration\n and Workgroup Settings Override Client-Side Settings.

" } + }, + "AclConfiguration": { + "target": "com.amazonaws.athena#AclConfiguration", + "traits": { + "smithy.api#documentation": "

Indicates that an Amazon S3 canned ACL should be set to control ownership of\n stored query results. Currently the only supported canned ACL is\n BUCKET_OWNER_FULL_CONTROL. This is a client-side setting. If workgroup\n settings override client-side settings, then the query uses the ACL configuration that\n is specified for the workgroup, and also uses the location for storing query results\n specified in the workgroup. For more information, see WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

" + } } }, "traits": { @@ -2756,6 +2789,18 @@ "traits": { "smithy.api#documentation": "

If set to \"true\", removes the Amazon Web Services account ID previously specified for\n ResultConfiguration$ExpectedBucketOwner. If set to \"false\" or not\n set, and a value is present in the ExpectedBucketOwner in\n ResultConfigurationUpdates (the client-side setting), the\n ExpectedBucketOwner in the workgroup's ResultConfiguration\n is updated with the new value. For more information, see Workgroup Settings Override\n Client-Side Settings.

" } + }, + "AclConfiguration": { + "target": "com.amazonaws.athena#AclConfiguration", + "traits": { + "smithy.api#documentation": "

The ACL configuration for the query results.

" + } + }, + "RemoveAclConfiguration": { + "target": "com.amazonaws.athena#BoxedBoolean", + "traits": { + "smithy.api#documentation": "

If set to true, indicates that the previously-specified ACL configuration\n for queries in this workgroup should be ignored and set to null. If set to\n false or not set, and a value is present in the\n AclConfiguration of ResultConfigurationUpdates, the\n AclConfiguration in the workgroup's ResultConfiguration is\n updated with the new value. For more information, see Workgroup Settings Override\n Client-Side Settings.

" + } } }, "traits": { @@ -2779,7 +2824,7 @@ } }, "traits": { - "smithy.api#documentation": "

The metadata and rows that comprise a query result set. The metadata describes the\n column structure and data types. To return a ResultSet object, use GetQueryResults.

" + "smithy.api#documentation": "

The metadata and rows that make up a query result set. The metadata describes the\n column structure and data types. To return a ResultSet object, use GetQueryResults.

" } }, "com.amazonaws.athena#ResultSetMetadata": { @@ -2807,7 +2852,7 @@ } }, "traits": { - "smithy.api#documentation": "

The rows that comprise a query result table.

" + "smithy.api#documentation": "

The rows that make up a query result table.

" } }, "com.amazonaws.athena#RowList": { @@ -2816,6 +2861,17 @@ "target": "com.amazonaws.athena#Row" } }, + "com.amazonaws.athena#S3AclOption": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "BUCKET_OWNER_FULL_CONTROL", + "name": "BUCKET_OWNER_FULL_CONTROL" + } + ] + } + }, "com.amazonaws.athena#StartQueryExecution": { "type": "operation", "input": { @@ -3334,6 +3390,63 @@ "type": "structure", "members": {} }, + "com.amazonaws.athena#UpdateNamedQuery": { + "type": "operation", + "input": { + "target": "com.amazonaws.athena#UpdateNamedQueryInput" + }, + "output": { + "target": "com.amazonaws.athena#UpdateNamedQueryOutput" + }, + "errors": [ + { + "target": "com.amazonaws.athena#InternalServerException" + }, + { + "target": "com.amazonaws.athena#InvalidRequestException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a NamedQuery object. The database or workgroup cannot be updated.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.athena#UpdateNamedQueryInput": { + "type": "structure", + "members": { + "NamedQueryId": { + "target": "com.amazonaws.athena#NamedQueryId", + "traits": { + "smithy.api#documentation": "

The unique identifier (UUID) of the query.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.athena#NameString", + "traits": { + "smithy.api#documentation": "

The name of the query.

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

The query description.

" + } + }, + "QueryString": { + "target": "com.amazonaws.athena#QueryString", + "traits": { + "smithy.api#documentation": "

The contents of the query with all query statements.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.athena#UpdateNamedQueryOutput": { + "type": "structure", + "members": {} + }, "com.amazonaws.athena#UpdatePreparedStatement": { "type": "operation", "input": { diff --git a/aws/sdk/aws-models/autoscaling.json b/aws/sdk/aws-models/autoscaling.json index 83ddeaad24..6fb25d9b68 100644 --- a/aws/sdk/aws-models/autoscaling.json +++ b/aws/sdk/aws-models/autoscaling.json @@ -1484,7 +1484,7 @@ } ], "traits": { - "smithy.api#documentation": "

Completes the lifecycle action for the specified token or instance with the specified\n result.

\n

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:

\n
    \n
  1. \n

    (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to\n invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates\n instances.

    \n
    2. \n
  2. \n

    (Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish\n lifecycle notifications to the target.

    \n
    3. \n
  3. \n

    Create the lifecycle hook. Specify whether the hook is used when the instances\n launch or terminate.

    \n
    4. \n
  4. \n

    If you need more time, record the lifecycle action heartbeat to keep the\n instance in a pending state.

    \n
    5. \n
  5. \n

    \n If you finish before the timeout period ends, send a\n callback by using the CompleteLifecycleAction API\n call.\n

    \n
    6. \n
\n

For more information, see Amazon EC2 Auto Scaling lifecycle\n hooks in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Completes the lifecycle action for the specified token or instance with the specified\n result.

\n

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:

\n
    \n
  1. \n

    (Optional) Create a launch template or launch configuration with a user data\n script that runs while an instance is in a wait state due to a lifecycle\n hook.

    \n
    2. \n
  2. \n

    (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke\n your Lambda function when an instance is put into a wait state due to a\n lifecycle hook.

    \n
    3. \n
  3. \n

    (Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish\n lifecycle notifications to the target.

    \n
    4. \n
  4. \n

    Create the lifecycle hook. Specify whether the hook is used when the instances\n launch or terminate.

    \n
    5. \n
  5. \n

    If you need more time, record the lifecycle action heartbeat to keep the\n instance in a wait state.

    \n
    6. \n
  6. \n

    \n If you finish before the timeout period ends, send a\n callback by using the CompleteLifecycleAction API\n call.\n

    \n
    7. \n
\n

For more information, see Amazon EC2 Auto Scaling lifecycle\n hooks in the Amazon EC2 Auto Scaling User Guide.

" } }, "com.amazonaws.autoscaling#CompleteLifecycleActionAnswer": { @@ -1583,7 +1583,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.\n

\n

Creates an Auto Scaling group with\n the specified name and attributes.

\n

If you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit,\n call the DescribeAccountLimits API. For information about updating\n this limit, see Amazon EC2 Auto Scaling service\n quotas in the Amazon EC2 Auto Scaling User Guide.

\n

For introductory exercises for creating an Auto Scaling group, see Getting started with\n Amazon EC2 Auto Scaling and Tutorial: Set up a\n scaled and load-balanced application in the\n Amazon EC2 Auto Scaling User Guide. For more information, see Auto Scaling\n groups in the Amazon EC2 Auto Scaling User Guide.

\n

Every Auto Scaling group has three size parameters (DesiredCapacity,\n MaxSize, and MinSize). Usually, you set these sizes based\n on a specific number of instances. However, if you configure a mixed instances policy\n that defines weights for the instance types, you must specify these sizes with the same\n units that you use for weighting instances.

" + "smithy.api#documentation": "

\n We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.\n

\n

Creates an Auto Scaling group with the specified name and attributes.

\n

If you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit,\n call the DescribeAccountLimits API. For information about updating\n this limit, see Amazon EC2 Auto Scaling service\n quotas in the Amazon EC2 Auto Scaling User Guide.

\n

For introductory exercises for creating an Auto Scaling group, see Getting started with\n Amazon EC2 Auto Scaling and Tutorial: Set up a\n scaled and load-balanced application in the\n Amazon EC2 Auto Scaling User Guide. For more information, see Auto Scaling\n groups in the Amazon EC2 Auto Scaling User Guide.

\n

Every Auto Scaling group has three size parameters (DesiredCapacity,\n MaxSize, and MinSize). Usually, you set these sizes based\n on a specific number of instances. However, if you configure a mixed instances policy\n that defines weights for the instance types, you must specify these sizes with the same\n units that you use for weighting instances.

" } }, "com.amazonaws.autoscaling#CreateAutoScalingGroupType": { @@ -1611,7 +1611,7 @@ "MixedInstancesPolicy": { "target": "com.amazonaws.autoscaling#MixedInstancesPolicy", "traits": { - "smithy.api#documentation": "

An embedded object that specifies a mixed instances policy.

\n \n \n \n

For more information, see Auto Scaling groups with multiple\n instance types and purchase options in the Amazon EC2 Auto Scaling User\n Guide.

" + "smithy.api#documentation": "

An embedded object that specifies a mixed instances policy.

\n \n \n \n

For more information, see Auto Scaling\n groups with multiple instance types and purchase options in the\n Amazon EC2 Auto Scaling User Guide.

" } }, "InstanceId": { @@ -1673,7 +1673,7 @@ "HealthCheckGracePeriod": { "target": "com.amazonaws.autoscaling#HealthCheckGracePeriod", "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status\n of an EC2 instance that has come into service and marking it unhealthy due to a failed\n health check. The default value is 0. For more information, see Health\n check grace period in the Amazon EC2 Auto Scaling User Guide.

\n

Conditional: Required if you are adding an ELB health check.

" + "smithy.api#documentation": "

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status\n of an EC2 instance that has come into service and marking it unhealthy due to a failed\n health check. The default value is 0. For more information, see Health\n check grace period in the Amazon EC2 Auto Scaling User Guide.

\n

Required if you are adding an ELB health check.

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

Gets information about a warm pool and its instances.

\n

For more information, see Warm pools for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Gets information about a warm pool and its instances.

\n

For more information, see Warm pools for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

" } }, "com.amazonaws.autoscaling#DescribeWarmPoolAnswer": { @@ -4284,13 +4284,13 @@ "SpotMaxPricePercentageOverLowestPrice": { "target": "com.amazonaws.autoscaling#NullablePositiveInteger", "traits": { - "smithy.api#documentation": "

The price protection threshold for Spot Instances. This is the maximum you’ll pay for\n a Spot Instance, expressed as a percentage higher than the cheapest M, C, or R instance\n type with your specified attributes. When Amazon EC2 Auto Scaling selects instance types with your\n attributes, we will exclude instance types whose price is higher than your threshold.\n The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. To turn off\n price protection, specify a high value, such as 999999.

\n

Default: 100\n

" + "smithy.api#documentation": "

The price protection threshold for Spot Instances. This is the maximum you’ll pay for\n a Spot Instance, expressed as a percentage higher than the cheapest M, C, or R instance\n type with your specified attributes. When Amazon EC2 Auto Scaling selects instance types with your\n attributes, we will exclude instance types whose price is higher than your threshold.\n The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. To turn off\n price protection, specify a high value, such as 999999.

\n

If you set DesiredCapacityType to vcpu or\n memory-mib, the price protection threshold is applied based on the per\n vCPU or per memory price instead of the per instance price.

\n

Default: 100\n

" } }, "OnDemandMaxPricePercentageOverLowestPrice": { "target": "com.amazonaws.autoscaling#NullablePositiveInteger", "traits": { - "smithy.api#documentation": "

The price protection threshold for On-Demand Instances. This is the maximum you’ll pay\n for an On-Demand Instance, expressed as a percentage higher than the cheapest M, C, or R\n instance type with your specified attributes. When Amazon EC2 Auto Scaling selects instance types with\n your attributes, we will exclude instance types whose price is higher than your\n threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.\n To turn off price protection, specify a high value, such as 999999.

\n

Default: 20\n

" + "smithy.api#documentation": "

The price protection threshold for On-Demand Instances. This is the maximum you’ll pay\n for an On-Demand Instance, expressed as a percentage higher than the cheapest M, C, or R\n instance type with your specified attributes. When Amazon EC2 Auto Scaling selects instance types with\n your attributes, we will exclude instance types whose price is higher than your\n threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.\n To turn off price protection, specify a high value, such as 999999.

\n

If you set DesiredCapacityType to vcpu or\n memory-mib, the price protection threshold is applied based on the per\n vCPU or per memory price instead of the per instance price.

\n

Default: 20\n

" } }, "BareMetal": { @@ -4376,6 +4376,20 @@ "smithy.api#documentation": "

When you specify multiple parameters, you get instance types that satisfy all of the\n specified parameters. If you specify multiple values for a parameter, you get instance\n types that satisfy any of the specified values.

\n \n \n

Represents requirements for the types of instances that can be launched. You\n must specify VCpuCount and MemoryMiB, but all other parameters\n are optional. For more information, see Creating\n an Auto Scaling group using attribute-based instance type selection in the\n Amazon EC2 Auto Scaling User Guide.

" } }, + "com.amazonaws.autoscaling#InstanceReusePolicy": { + "type": "structure", + "members": { + "ReuseOnScaleIn": { + "target": "com.amazonaws.autoscaling#ReuseOnScaleIn", + "traits": { + "smithy.api#documentation": "

Specifies whether instances in the Auto Scaling group can be returned to the warm pool on\n scale in.

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

Describes an instance reuse policy for a warm pool.

\n

For more information, see Warm pools for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

" + } + }, "com.amazonaws.autoscaling#Instances": { "type": "list", "member": { @@ -4704,13 +4718,13 @@ "WeightedCapacity": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", "traits": { - "smithy.api#documentation": "

The number of capacity units provided by the instance type specified in\n InstanceType in terms of virtual CPUs, memory, storage, throughput, or\n other relative performance characteristic. When a Spot or On-Demand Instance is\n launched, the capacity units count toward the desired capacity. Amazon EC2 Auto Scaling launches\n instances until the desired capacity is totally fulfilled, even if this results in an\n overage. For example, if there are two units remaining to fulfill capacity, and Amazon EC2 Auto Scaling\n can only launch an instance with a WeightedCapacity of five units, the\n instance is launched, and the desired capacity is exceeded by three units. For more\n information, see Instance weighting for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide. Value must be in the\n range of 1–999.

" + "smithy.api#documentation": "

The number of capacity units provided by the instance type specified in\n InstanceType in terms of virtual CPUs, memory, storage, throughput, or\n other relative performance characteristic. When a Spot or On-Demand Instance is\n launched, the capacity units count toward the desired capacity. Amazon EC2 Auto Scaling launches\n instances until the desired capacity is totally fulfilled, even if this results in an\n overage. For example, if there are two units remaining to fulfill capacity, and Amazon EC2 Auto Scaling\n can only launch an instance with a WeightedCapacity of five units, the\n instance is launched, and the desired capacity is exceeded by three units. For more\n information, see Configuring instance weighting for Amazon EC2 Auto Scaling in the\n Amazon EC2 Auto Scaling User Guide. Value must be in the range of 1–999.

" } }, "LaunchTemplateSpecification": { "target": "com.amazonaws.autoscaling#LaunchTemplateSpecification", "traits": { - "smithy.api#documentation": "

Provides the launch template to be used when launching the instance type specified in\n InstanceType. For example, some instance types might require a launch\n template with a different AMI. If not provided, Amazon EC2 Auto Scaling uses the launch template that's\n defined for your mixed instances policy. For more information, see Specifying a\n different launch template for an instance type in the\n Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Provides a launch template for the specified instance type or instance requirements.\n For example, some instance types might require a launch template with a different AMI.\n If not provided, Amazon EC2 Auto Scaling uses the launch template that's defined for your mixed\n instances policy. For more information, see Specifying a different launch template for an instance type in the\n Amazon EC2 Auto Scaling User Guide.

" } }, "InstanceRequirements": { @@ -4792,7 +4806,7 @@ "RoleARN": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified\n notification target.

" + "smithy.api#documentation": "

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified\n notification target (an Amazon SNS topic or an Amazon SQS queue).

" } }, "NotificationMetadata": { @@ -4821,7 +4835,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes a lifecycle hook, which enables an Auto Scaling group to be aware of events in the\n Auto Scaling instance lifecycle, and then perform a custom action when the corresponding\n lifecycle event occurs.

" + "smithy.api#documentation": "

Describes a lifecycle hook. A lifecycle hook lets you create solutions that are aware\n of events in the Auto Scaling instance lifecycle, and then perform a custom action on instances\n when the corresponding lifecycle event\n occurs.

" } }, "com.amazonaws.autoscaling#LifecycleHookNames": { @@ -4880,7 +4894,7 @@ "RoleARN": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified\n notification target, for example, an Amazon SNS topic or an Amazon SQS queue.

" + "smithy.api#documentation": "

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified\n notification target.

\n

Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue. Required\n for new lifecycle hooks, but optional when updating existing hooks.

" } } }, @@ -4991,6 +5005,10 @@ { "value": "Warmed:Running", "name": "WARMED_RUNNING" + }, + { + "value": "Warmed:Hibernated", + "name": "WARMED_HIBERNATED" } ] } @@ -5758,7 +5776,7 @@ "PredefinedMetricType": { "target": "com.amazonaws.autoscaling#MetricType", "traits": { - "smithy.api#documentation": "

The metric type. The following predefined metrics are available:

\n
    \n
  • \n

    \n ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling\n group.

    \n
    • \n
  • \n

    \n ASGAverageNetworkIn - Average number of bytes received on all\n network interfaces by the Auto Scaling group.

    \n
    • \n
  • \n

    \n ASGAverageNetworkOut - Average number of bytes sent out on all\n network interfaces by the Auto Scaling group.

    \n
    • \n
  • \n

    \n ALBRequestCountPerTarget - Number of requests completed per\n target in an Application Load Balancer target group.

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

The metric type. The following predefined metrics are available:

\n
    \n
  • \n

    \n ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling\n group.

    \n
    • \n
  • \n

    \n ASGAverageNetworkIn - Average number of bytes received (per\n instance per minute) for the Auto Scaling group.

    \n
    • \n
  • \n

    \n ASGAverageNetworkOut - Average number of bytes sent out (per\n instance per minute) for the Auto Scaling group.

    \n
    • \n
  • \n

    \n ALBRequestCountPerTarget - Average Application Load Balancer request count (per\n target per minute) for your Auto Scaling group.

    \n
    • \n
", "smithy.api#required": {} } }, @@ -6131,7 +6149,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates or updates a lifecycle hook for the specified Auto Scaling group.

\n

A lifecycle hook enables an Auto Scaling group to be aware of events in the Auto Scaling instance\n lifecycle, and then perform a custom action when the corresponding lifecycle event\n occurs.

\n

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:

\n
    \n
  1. \n

    (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to\n invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates\n instances.

    \n
    2. \n
  2. \n

    (Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish\n lifecycle notifications to the target.

    \n
    3. \n
  3. \n

    \n Create the lifecycle hook. Specify whether the hook is\n used when the instances launch or terminate.\n

    \n
    4. \n
  4. \n

    If you need more time, record the lifecycle action heartbeat to keep the\n instance in a pending state using the RecordLifecycleActionHeartbeat API call.

    \n
    5. \n
  5. \n

    If you finish before the timeout period ends, send a callback by using the\n CompleteLifecycleAction API call.

    \n
    6. \n
\n

For more information, see Amazon EC2 Auto Scaling lifecycle\n hooks in the Amazon EC2 Auto Scaling User Guide.

\n

If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling\n group, the call fails.

\n

You can view the lifecycle hooks for an Auto Scaling group using the DescribeLifecycleHooks API call. If you are no longer using a lifecycle\n hook, you can delete it by calling the DeleteLifecycleHook API.

" + "smithy.api#documentation": "

Creates or updates a lifecycle hook for the specified Auto Scaling group.

\n

Lifecycle hooks let you create solutions that are aware of events in the Auto Scaling instance\n lifecycle, and then perform a custom action on instances when the corresponding\n lifecycle event occurs.

\n

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:

\n
    \n
  1. \n

    (Optional) Create a launch template or launch configuration with a user data\n script that runs while an instance is in a wait state due to a lifecycle\n hook.

    \n
    2. \n
  2. \n

    (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke\n your Lambda function when an instance is put into a wait state due to a\n lifecycle hook.

    \n
    3. \n
  3. \n

    (Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish\n lifecycle notifications to the target.

    \n
    4. \n
  4. \n

    \n Create the lifecycle hook. Specify whether the hook is\n used when the instances launch or terminate.\n

    \n
    5. \n
  5. \n

    If you need more time, record the lifecycle action heartbeat to keep the\n instance in a wait state using the RecordLifecycleActionHeartbeat API call.

    \n
    6. \n
  6. \n

    If you finish before the timeout period ends, send a callback by using the\n CompleteLifecycleAction API call.

    \n
    7. \n
\n

For more information, see Amazon EC2 Auto Scaling lifecycle\n hooks in the Amazon EC2 Auto Scaling User Guide.

\n

If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling\n group, the call fails.

\n

You can view the lifecycle hooks for an Auto Scaling group using the DescribeLifecycleHooks API call. If you are no longer using a lifecycle\n hook, you can delete it by calling the DeleteLifecycleHook API.

" } }, "com.amazonaws.autoscaling#PutLifecycleHookAnswer": { @@ -6164,7 +6182,7 @@ "RoleARN": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified\n notification target, for example, an Amazon SNS topic or an Amazon SQS queue.

\n

Required for new lifecycle hooks, but optional when updating existing hooks.

" + "smithy.api#documentation": "

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified\n notification target.

\n

Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue. Required\n for new lifecycle hooks, but optional when updating existing hooks.

" } }, "NotificationTargetARN": { @@ -6491,6 +6509,12 @@ "traits": { "smithy.api#documentation": "

Sets the instance state to transition to after the lifecycle actions are complete.\n Default is Stopped.

" } + }, + "InstanceReusePolicy": { + "target": "com.amazonaws.autoscaling#InstanceReusePolicy", + "traits": { + "smithy.api#documentation": "

Indicates whether instances in the Auto Scaling group can be returned to the warm pool on\n scale in. The default is to terminate instances in the Auto Scaling group when the group scales\n in.

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

Records a heartbeat for the lifecycle action associated with the specified token or\n instance. This extends the timeout by the length of time defined using the PutLifecycleHook API call.

\n

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:

\n
    \n
  1. \n

    (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to\n invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates\n instances.

    \n
    2. \n
  2. \n

    (Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish\n lifecycle notifications to the target.

    \n
    3. \n
  3. \n

    Create the lifecycle hook. Specify whether the hook is used when the instances\n launch or terminate.

    \n
    4. \n
  4. \n

    \n If you need more time, record the lifecycle action\n heartbeat to keep the instance in a pending state.\n

    \n
    5. \n
  5. \n

    If you finish before the timeout period ends, send a callback by using the\n CompleteLifecycleAction API call.

    \n
    6. \n
\n

For more information, see Amazon EC2 Auto Scaling lifecycle\n hooks in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Records a heartbeat for the lifecycle action associated with the specified token or\n instance. This extends the timeout by the length of time defined using the PutLifecycleHook API call.

\n

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:

\n
    \n
  1. \n

    (Optional) Create a launch template or launch configuration with a user data\n script that runs while an instance is in a wait state due to a lifecycle\n hook.

    \n
    2. \n
  2. \n

    (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke\n your Lambda function when an instance is put into a wait state due to a\n lifecycle hook.

    \n
    3. \n
  3. \n

    (Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish\n lifecycle notifications to the target.

    \n
    4. \n
  4. \n

    Create the lifecycle hook. Specify whether the hook is used when the instances\n launch or terminate.

    \n
    5. \n
  5. \n

    \n If you need more time, record the lifecycle action\n heartbeat to keep the instance in a wait state.\n

    \n
    6. \n
  6. \n

    If you finish before the timeout period ends, send a callback by using the\n CompleteLifecycleAction API call.

    \n
    7. \n
\n

For more information, see Amazon EC2 Auto Scaling lifecycle\n hooks in the Amazon EC2 Auto Scaling User Guide.

" } }, "com.amazonaws.autoscaling#RecordLifecycleActionHeartbeatAnswer": { @@ -6677,6 +6701,12 @@ "smithy.api#box": {} } }, + "com.amazonaws.autoscaling#ReuseOnScaleIn": { + "type": "boolean", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.autoscaling#ScalingActivityInProgressFault": { "type": "structure", "members": { @@ -6939,13 +6969,13 @@ "StartTime": { "target": "com.amazonaws.autoscaling#TimestampType", "traits": { - "smithy.api#documentation": "

The date and time in UTC for this action to start. For example,\n \"2019-06-01T00:00:00Z\".\n

" + "smithy.api#documentation": "

The date and time in UTC for this action to start. For example,\n \"2019-06-01T00:00:00Z\".

" } }, "EndTime": { "target": "com.amazonaws.autoscaling#TimestampType", "traits": { - "smithy.api#documentation": "

The date and time in UTC for the recurring schedule to end. For example,\n \"2019-06-01T00:00:00Z\".\n

" + "smithy.api#documentation": "

The date and time in UTC for the recurring schedule to end. For example,\n \"2019-06-01T00:00:00Z\".

" } }, "Recurrence": { @@ -7529,7 +7559,7 @@ "TargetValue": { "target": "com.amazonaws.autoscaling#MetricScale", "traits": { - "smithy.api#documentation": "

The target value for the metric.

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

The target value for the metric.

\n \n

Some metrics are based on a count instead of a percentage, such as the request\n count for an Application Load Balancer or the number of messages in an SQS queue. If the scaling policy\n specifies one of these metrics, specify the target utilization as the optimal\n average request or message count per instance during any one-minute interval.\n

\n ", "smithy.api#required": {} } }, @@ -7629,7 +7659,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.\n

\n

Updates the configuration for\n the specified Auto Scaling group.

\n

To update an Auto Scaling group, specify the name of the group and the parameter that you want\n to change. Any parameters that you don't specify are not changed by this update request.\n The new settings take effect on any scaling activities after this call returns.\n

\n

If you associate a new launch configuration or template with an Auto Scaling group, all new\n instances will get the updated configuration. Existing instances continue to run with\n the configuration that they were originally launched with. When you update a group to\n specify a mixed instances policy instead of a launch configuration or template, existing\n instances may be replaced to match the new purchasing options that you specified in the\n policy. For example, if the group currently has 100% On-Demand capacity and the policy\n specifies 50% Spot capacity, this means that half of your instances will be gradually\n terminated and relaunched as Spot Instances. When replacing instances, Amazon EC2 Auto Scaling launches\n new instances before terminating the old ones, so that updating your group does not\n compromise the performance or availability of your application.

\n

Note the following about changing DesiredCapacity, MaxSize,\n or MinSize:

\n
    \n
  • \n

    If a scale-in activity occurs as a result of a new\n DesiredCapacity value that is lower than the current size of\n the group, the Auto Scaling group uses its termination policy to determine which\n instances to terminate.

    \n
    • \n
  • \n

    If you specify a new value for MinSize without specifying a value\n for DesiredCapacity, and the new MinSize is larger\n than the current size of the group, this sets the group's\n DesiredCapacity to the new MinSize value.

    \n
    • \n
  • \n

    If you specify a new value for MaxSize without specifying a value\n for DesiredCapacity, and the new MaxSize is smaller\n than the current size of the group, this sets the group's\n DesiredCapacity to the new MaxSize value.

    \n
    • \n
\n

To see which parameters have been set, call the DescribeAutoScalingGroups API. To view the scaling policies for an Auto Scaling\n group, call the DescribePolicies API. If the group has scaling\n policies, you can update them by calling the PutScalingPolicy\n API.

" + "smithy.api#documentation": "

\n We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.\n

\n

Updates the configuration for the specified Auto Scaling group.

\n

To update an Auto Scaling group, specify the name of the group and the parameter that you want\n to change. Any parameters that you don't specify are not changed by this update request.\n The new settings take effect on any scaling activities after this call returns.\n

\n

If you associate a new launch configuration or template with an Auto Scaling group, all new\n instances will get the updated configuration. Existing instances continue to run with\n the configuration that they were originally launched with. When you update a group to\n specify a mixed instances policy instead of a launch configuration or template, existing\n instances may be replaced to match the new purchasing options that you specified in the\n policy. For example, if the group currently has 100% On-Demand capacity and the policy\n specifies 50% Spot capacity, this means that half of your instances will be gradually\n terminated and relaunched as Spot Instances. When replacing instances, Amazon EC2 Auto Scaling launches\n new instances before terminating the old ones, so that updating your group does not\n compromise the performance or availability of your application.

\n

Note the following about changing DesiredCapacity, MaxSize,\n or MinSize:

\n
    \n
  • \n

    If a scale-in activity occurs as a result of a new\n DesiredCapacity value that is lower than the current size of\n the group, the Auto Scaling group uses its termination policy to determine which\n instances to terminate.

    \n
    • \n
  • \n

    If you specify a new value for MinSize without specifying a value\n for DesiredCapacity, and the new MinSize is larger\n than the current size of the group, this sets the group's\n DesiredCapacity to the new MinSize value.

    \n
    • \n
  • \n

    If you specify a new value for MaxSize without specifying a value\n for DesiredCapacity, and the new MaxSize is smaller\n than the current size of the group, this sets the group's\n DesiredCapacity to the new MaxSize value.

    \n
    • \n
\n

To see which parameters have been set, call the DescribeAutoScalingGroups API. To view the scaling policies for an Auto Scaling\n group, call the DescribePolicies API. If the group has scaling\n policies, you can update them by calling the PutScalingPolicy\n API.

" } }, "com.amazonaws.autoscaling#UpdateAutoScalingGroupType": { @@ -7657,7 +7687,7 @@ "MixedInstancesPolicy": { "target": "com.amazonaws.autoscaling#MixedInstancesPolicy", "traits": { - "smithy.api#documentation": "

An embedded object that specifies a mixed instances policy. For more information, see\n Auto Scaling groups with multiple\n instance types and purchase options in the Amazon EC2 Auto Scaling User\n Guide.

" + "smithy.api#documentation": "

An embedded object that specifies a mixed instances policy. For more information, see\n Auto Scaling\n groups with multiple instance types and purchase options in the\n Amazon EC2 Auto Scaling User Guide.

" } }, "MinSize": { @@ -7699,7 +7729,7 @@ "HealthCheckGracePeriod": { "target": "com.amazonaws.autoscaling#HealthCheckGracePeriod", "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status\n of an EC2 instance that has come into service and marking it unhealthy due to a failed\n health check. The default value is 0. For more information, see Health\n check grace period in the Amazon EC2 Auto Scaling User Guide.

\n

Conditional: Required if you are adding an ELB health check.

" + "smithy.api#documentation": "

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status\n of an EC2 instance that has come into service and marking it unhealthy due to a failed\n health check. The default value is 0. For more information, see Health\n check grace period in the Amazon EC2 Auto Scaling User Guide.

\n

Required if you are adding an ELB health check.

" } }, "PlacementGroup": { @@ -7811,6 +7841,12 @@ "traits": { "smithy.api#documentation": "

The status of a warm pool that is marked for deletion.

" } + }, + "InstanceReusePolicy": { + "target": "com.amazonaws.autoscaling#InstanceReusePolicy", + "traits": { + "smithy.api#documentation": "

The instance reuse policy.

" + } } }, "traits": { @@ -7843,6 +7879,10 @@ { "value": "Running", "name": "Running" + }, + { + "value": "Hibernated", + "name": "Hibernated" } ] } diff --git a/aws/sdk/aws-models/chime-sdk-meetings.json b/aws/sdk/aws-models/chime-sdk-meetings.json index a8f3cb85e3..fcce20400d 100644 --- a/aws/sdk/aws-models/chime-sdk-meetings.json +++ b/aws/sdk/aws-models/chime-sdk-meetings.json @@ -83,7 +83,7 @@ } }, "traits": { - "smithy.api#documentation": "

An optional category of meeting features that contains audio-specific configurations, such as operating parameters for Amazon Voice Focus.

" + "smithy.api#documentation": "

An optional category of meeting features that contains audio-specific configurations, such as operating parameters for Amazon Voice Focus.

" } }, "com.amazonaws.chimesdkmeetings#BadRequestException": { @@ -205,7 +205,7 @@ "name": "chime" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

The Amazon Chime SDK meetings APIs in this section allow software developers to create Amazon Chime SDK meetings, set the AWS Regions for meetings, create and manage users, and send and \n receive meeting notifications. For more information \n about the meeting APIs, see Amazon Chime SDK meetings.

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

The Amazon Chime SDK meetings APIs in this section allow software developers to create Amazon Chime SDK meetings, set the AWS Regions for meetings, create and manage users, and send and \n receive meeting notifications. For more information about the meeting APIs, see Amazon Chime SDK meetings.

", "smithy.api#title": "Amazon Chime SDK Meetings" }, "version": "2021-07-15", @@ -425,7 +425,7 @@ "MediaRegion": { "target": "com.amazonaws.chimesdkmeetings#MediaRegion", "traits": { - "smithy.api#documentation": "

The Region in which to create the meeting.

\n \n

\n Available values: \n af-south-1\n , \n ap-northeast-1\n , \n ap-northeast-2\n , \n ap-south-1\n , \n ap-southeast-1\n , \n ap-southeast-2\n , \n ca-central-1\n , \n eu-central-1\n , \n eu-north-1\n , \n eu-south-1\n , \n eu-west-1\n , \n eu-west-2\n , \n eu-west-3\n , \n sa-east-1\n , \n us-east-1\n , \n us-east-2\n , \n us-west-1\n , \n us-west-2\n .\n

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

The Region in which to create the meeting.

\n \n

\n Available values: \n af-south-1, \n ap-northeast-1, \n ap-northeast-2, \n ap-south-1, \n ap-southeast-1, \n ap-southeast-2, \n ca-central-1, \n eu-central-1, \n eu-north-1, \n eu-south-1, \n eu-west-1, \n eu-west-2, \n eu-west-3, \n sa-east-1, \n us-east-1, \n us-east-2, \n us-west-1, \n us-west-2.\n

\n

Available values in AWS GovCloud (US) Regions: us-gov-east-1, us-gov-west-1.

", "smithy.api#required": {} } }, @@ -512,7 +512,7 @@ "MediaRegion": { "target": "com.amazonaws.chimesdkmeetings#MediaRegion", "traits": { - "smithy.api#documentation": "

The Region in which to create the meeting.

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

The Region in which to create the meeting.

\n \n

\n Available values: \n af-south-1, \n ap-northeast-1, \n ap-northeast-2, \n ap-south-1, \n ap-southeast-1, \n ap-southeast-2, \n ca-central-1, \n eu-central-1, \n eu-north-1, \n eu-south-1, \n eu-west-1, \n eu-west-2, \n eu-west-3, \n sa-east-1, \n us-east-1, \n us-east-2, \n us-west-1, \n us-west-2.\n

\n

Available values in AWS GovCloud (US) Regions: us-gov-east-1, us-gov-west-1.

", "smithy.api#required": {} } }, @@ -716,8 +716,7 @@ "LanguageCode": { "target": "com.amazonaws.chimesdkmeetings#TranscribeLanguageCode", "traits": { - "smithy.api#documentation": "

The language code specified for the Amazon Transcribe engine.

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

The language code specified for the Amazon Transcribe engine.

" } }, "VocabularyFilterMethod": { @@ -771,7 +770,7 @@ "PiiEntityTypes": { "target": "com.amazonaws.chimesdkmeetings#TranscribePiiEntityTypes", "traits": { - "smithy.api#documentation": "

Lists the PII entity types you want to identify or redact. To specify entity types, you must enable ContentIdentificationType or ContentRedactionType.

\n \n

PIIEntityTypes must be comma-separated. The available values are: \n BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, \n ADDRESS, NAME, PHONE, SSN, and ALL.

\n \n

\n PiiEntityTypes is an optional parameter with a default value of ALL.

" + "smithy.api#documentation": "

Lists the PII entity types you want to identify or redact. To specify entity types, you must enable ContentIdentificationType or ContentRedactionType.

\n \n

\n PIIEntityTypes must be comma-separated. The available values are: \n BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, \n ADDRESS, NAME, PHONE, SSN, and ALL.

\n \n

\n PiiEntityTypes is an optional parameter with a default value of ALL.

" } }, "LanguageModelName": { @@ -779,6 +778,24 @@ "traits": { "smithy.api#documentation": "

The name of the language model used during transcription.

" } + }, + "IdentifyLanguage": { + "target": "com.amazonaws.chimesdkmeetings#Boolean", + "traits": { + "smithy.api#documentation": "

Automatically identifies the language spoken in media files.

" + } + }, + "LanguageOptions": { + "target": "com.amazonaws.chimesdkmeetings#TranscribeLanguageOptions", + "traits": { + "smithy.api#documentation": "

Language codes for the languages that you want to identify. You must provide at least 2 codes.

" + } + }, + "PreferredLanguage": { + "target": "com.amazonaws.chimesdkmeetings#TranscribeLanguageCode", + "traits": { + "smithy.api#documentation": "

Language code for the preferred language.

" + } } }, "traits": { @@ -1143,7 +1160,7 @@ "MediaRegion": { "target": "com.amazonaws.chimesdkmeetings#MediaRegion", "traits": { - "smithy.api#documentation": "

The Region in which you create the meeting. Available values: af-south-1, ap-northeast-1, \n ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, ca-central-1, \n eu-central-1, eu-north-1, eu-south-1,\n eu-west-1, eu-west-2, eu-west-3,\n sa-east-1, us-east-1, us-east-2,\n us-west-1, us-west-2.

" + "smithy.api#documentation": "

The Region in which you create the meeting. Available values: af-south-1, ap-northeast-1, \n ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, ca-central-1, \n eu-central-1, eu-north-1, eu-south-1,\n eu-west-1, eu-west-2, eu-west-3,\n sa-east-1, us-east-1, us-east-2,\n us-west-1, us-west-2.

\n

Available values in AWS GovCloud (US) Regions: us-gov-east-1, us-gov-west-1.

" } }, "MediaPlacement": { @@ -1189,7 +1206,7 @@ } }, "traits": { - "smithy.api#documentation": "

The configuration settings of the features available to a meeting.

" + "smithy.api#documentation": "

The configuration settings of the features available to a meeting.>

" } }, "com.amazonaws.chimesdkmeetings#NotFoundException": { @@ -1482,6 +1499,16 @@ "smithy.api#pattern": "^[0-9a-zA-Z._-]+$" } }, + "com.amazonaws.chimesdkmeetings#TranscribeLanguageOptions": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[a-zA-Z-,]+$" + } + }, "com.amazonaws.chimesdkmeetings#TranscribeMedicalContentIdentificationType": { "type": "string", "traits": { diff --git a/aws/sdk/aws-models/chime.json b/aws/sdk/aws-models/chime.json index 322c7e9b89..830e5103ca 100644 --- a/aws/sdk/aws-models/chime.json +++ b/aws/sdk/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/aws/sdk/aws-models/cloudtrail.json b/aws/sdk/aws-models/cloudtrail.json index 35d6671778..99462381ff 100644 --- a/aws/sdk/aws-models/cloudtrail.json +++ b/aws/sdk/aws-models/cloudtrail.json @@ -245,7 +245,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels a query if the query is not in a terminated state, such as CANCELLED, FAILED or FINISHED. You must specify an ARN value for EventDataStore. \n The ID of the query that you want to cancel is also required. When you run CancelQuery, the query status might \n show as CANCELLED even if the operation is not yet finished.

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

Cancels a query if the query is not in a terminated state, such as CANCELLED, FAILED, TIMED_OUT, or FINISHED. You must specify an ARN value for EventDataStore.\n The ID of the query that you want to cancel is also required. When you run CancelQuery, the query status might \n show as CANCELLED even if the operation is not yet finished.

", "smithy.api#idempotent": {} } }, @@ -1152,7 +1152,7 @@ "QueryStatus": { "target": "com.amazonaws.cloudtrail#QueryStatus", "traits": { - "smithy.api#documentation": "

The status of a query. Values for QueryStatus include QUEUED, RUNNING, \n FINISHED, FAILED, or CANCELLED\n

" + "smithy.api#documentation": "

The status of a query. Values for QueryStatus include QUEUED, RUNNING, \n FINISHED, FAILED, TIMED_OUT, or CANCELLED\n

" } }, "QueryStatistics": { @@ -1883,7 +1883,7 @@ "QueryStatus": { "target": "com.amazonaws.cloudtrail#QueryStatus", "traits": { - "smithy.api#documentation": "

The status of the query. Values include QUEUED, RUNNING, FINISHED, FAILED, \n or CANCELLED.

" + "smithy.api#documentation": "

The status of the query. Values include QUEUED, RUNNING, FINISHED, FAILED, \n TIMED_OUT, or CANCELLED.

" } }, "QueryStatistics": { @@ -2146,7 +2146,7 @@ "code": "InactiveQuery", "httpResponseCode": 400 }, - "smithy.api#documentation": "

The specified query cannot be canceled because it is in the FINISHED, FAILED, or \n CANCELLED state.

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

The specified query cannot be canceled because it is in the FINISHED, FAILED, TIMED_OUT, or\n CANCELLED state.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -3008,7 +3008,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of queries and query statuses for the past seven days. You must specify an ARN value for \n EventDataStore. Optionally, to shorten the list of results, you can specify a time range, \n formatted as timestamps, by adding StartTime and EndTime parameters, and a \n QueryStatus value. Valid values for QueryStatus include QUEUED, RUNNING, \n FINISHED, FAILED, or CANCELLED.

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

Returns a list of queries and query statuses for the past seven days. You must specify an ARN value for \n EventDataStore. Optionally, to shorten the list of results, you can specify a time range, \n formatted as timestamps, by adding StartTime and EndTime parameters, and a \n QueryStatus value. Valid values for QueryStatus include QUEUED, RUNNING, \n FINISHED, FAILED, TIMED_OUT, or CANCELLED.

", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", @@ -3064,7 +3064,7 @@ "QueryStatus": { "target": "com.amazonaws.cloudtrail#QueryStatus", "traits": { - "smithy.api#documentation": "

The status of queries that you want to return in results. Valid values for QueryStatus include QUEUED, RUNNING, \n FINISHED, FAILED, or CANCELLED.

" + "smithy.api#documentation": "

The status of queries that you want to return in results. Valid values for QueryStatus include QUEUED, RUNNING, \n FINISHED, FAILED, TIMED_OUT, or CANCELLED.

" } } } @@ -3807,7 +3807,7 @@ "QueryStatus": { "target": "com.amazonaws.cloudtrail#QueryStatus", "traits": { - "smithy.api#documentation": "

The status of the query. This can be QUEUED, RUNNING, FINISHED, FAILED, \n or CANCELLED.

" + "smithy.api#documentation": "

The status of the query. This can be QUEUED, RUNNING, FINISHED, FAILED, \n TIMED_OUT, or CANCELLED.

" } }, "CreationTime": { @@ -3892,6 +3892,12 @@ "traits": { "smithy.api#documentation": "

The total number of results returned by a query.

" } + }, + "BytesScanned": { + "target": "com.amazonaws.cloudtrail#Long", + "traits": { + "smithy.api#documentation": "

The total bytes that the query scanned in the event data store. This value matches the number of\n bytes for which your account is billed for the query, unless the query is still running.

" + } } }, "traits": { @@ -3913,6 +3919,12 @@ "smithy.api#documentation": "

The number of events that the query scanned in the event data store.

" } }, + "BytesScanned": { + "target": "com.amazonaws.cloudtrail#Long", + "traits": { + "smithy.api#documentation": "

The total bytes that the query scanned in the event data store. This value matches the number of \n bytes for which your account is billed for the query, unless the query is still running.

" + } + }, "ExecutionTimeInMillis": { "target": "com.amazonaws.cloudtrail#Integer", "traits": { @@ -3953,6 +3965,10 @@ { "value": "CANCELLED", "name": "CANCELLED" + }, + { + "value": "TIMED_OUT", + "name": "TIMED_OUT" } ] } diff --git a/aws/sdk/aws-models/cognito-idp.json b/aws/sdk/aws-models/cognito-idp.json index 6659545c56..7fc817d042 100644 --- a/aws/sdk/aws-models/cognito-idp.json +++ b/aws/sdk/aws-models/cognito-idp.json @@ -399,7 +399,7 @@ "EventAction": { "target": "com.amazonaws.cognitoidentityprovider#AccountTakeoverEventActionType", "traits": { - "smithy.api#documentation": "

The event action.

\n \n
    \n
  • \n

    \n BLOCK Choosing this action will block the request.

    \n
    • \n
  • \n

    \n MFA_IF_CONFIGURED Present an MFA challenge if user has configured it, else allow the request.

    \n
    • \n
  • \n

    \n MFA_REQUIRED Present an MFA challenge if user has configured it, else block the request.

    \n
    • \n
  • \n

    \n NO_ACTION Allow the user to sign in.

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

The action to take in response to the account takeover action. Valid values\n are:

\n \n
    \n
  • \n

    \n BLOCK Choosing this action will block the request.

    \n
    • \n
  • \n

    \n MFA_IF_CONFIGURED Present an MFA challenge if user has configured it, else allow the request.

    \n
    • \n
  • \n

    \n MFA_REQUIRED Present an MFA challenge if user has configured it, else block the request.

    \n
    • \n
  • \n

    \n NO_ACTION Allow the user to sign in.

    \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
  • \n

    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration \n doesn't include triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Validate the ClientMetadata value.

    \n
    • \n
  • \n

    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

    \n
    • \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
  • \n

    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration \n doesn't include triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Validate the ClientMetadata value.

    \n
    • \n
  • \n

    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

    \n
    • \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
  • \n

    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool \n configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Validate the ClientMetadata value.

    \n
    • \n
  • \n

    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

    \n
    • \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
  • \n

    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool \n configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Validate the ClientMetadata value.

    \n
    • \n
  • \n

    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

    \n
    • \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
    \n
  • \n

    UNCONFIRMED - User has been created but not confirmed.

    \n
    • \n
  • \n

    CONFIRMED - User has been confirmed.

    \n
    • \n
  • \n

    ARCHIVED - User is no longer active.

    \n
    • \n
  • \n

    COMPROMISED - User is disabled due to a potential security threat.

    \n
    • \n
  • \n

    UNKNOWN - User status isn't known.

    \n
    • \n
  • \n

    RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.

    \n
    • \n
  • \n

    FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value \n before doing anything else.

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

The user status. Can be one of the following:

\n
    \n
  • \n

    UNCONFIRMED - User has been created but not confirmed.

    \n
    • \n
  • \n

    CONFIRMED - User has been confirmed.

    \n
    • \n
  • \n

    ARCHIVED - User is no longer active.

    \n
    • \n
  • \n

    UNKNOWN - User status isn't known.

    \n
    • \n
  • \n

    RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.

    \n
    • \n
  • \n

    FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value \n before doing anything else.

    \n
    • \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
  • \n

    Pre signup

    \n
    • \n
  • \n

    Pre authentication

    \n
    • \n
  • \n

    User migration

    \n
    • \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
  • \n

    Post authentication

    \n
    • \n
  • \n

    Custom message

    \n
    • \n
  • \n

    Pre token generation

    \n
    • \n
  • \n

    Create auth challenge

    \n
    • \n
  • \n

    Define auth challenge

    \n
    • \n
  • \n

    Verify auth challenge

    \n
    • \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
  • \n

    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration \n doesn't include triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Validate the ClientMetadata value.

    \n
    • \n
  • \n

    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

    \n
    • \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
  • \n

    Pre signup

    \n
    • \n
  • \n

    Pre authentication

    \n
    • \n
  • \n

    User migration

    \n
    • \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

    Post authentication

    \n
    • \n
  • \n

    Custom message

    \n
    • \n
  • \n

    Pre token generation

    \n
    • \n
  • \n

    Create auth challenge

    \n
    • \n
  • \n

    Define auth challenge

    \n
    • \n
  • \n

    Verify auth challenge

    \n
    • \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
  • \n

    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration \n doesn't include triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Validate the ClientMetadata value.

    \n
    • \n
  • \n

    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

    \n
    • \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
  • \n

    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool \n configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Validate the ClientMetadata value.

    \n
    • \n
  • \n

    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

    \n
    • \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
  • \n

    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool \n configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Validate the ClientMetadata value.

    \n
    • \n
  • \n

    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

    \n
    • \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
  • \n

    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration \n doesn't include triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Validate the ClientMetadata value.

    \n
    • \n
  • \n

    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

    \n
    • \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
  • \n

    pre sign-up

    \n
    • \n
  • \n

    custom message

    \n
    • \n
  • \n

    post authentication

    \n
    • \n
  • \n

    user migration

    \n
    • \n
  • \n

    pre token generation

    \n
    • \n
  • \n

    define auth challenge

    \n
    • \n
  • \n

    create auth challenge

    \n
    • \n
  • \n

    verify auth challenge response

    \n
    • \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
  • \n

    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration \n doesn't include triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Validate the ClientMetadata value.

    \n
    • \n
  • \n

    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

    \n
    • \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
  • \n

    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool \n configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Validate the ClientMetadata value.

    \n
    • \n
  • \n

    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

    \n
    • \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
  • \n

    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool \n configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Validate the ClientMetadata value.

    \n
    • \n
  • \n

    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

    \n
    • \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
  • \n

    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool \n configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Validate the ClientMetadata value.

    \n
    • \n
  • \n

    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

    \n
    • \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
  • \n

    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool \n configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Validate the ClientMetadata value.

    \n
    • \n
  • \n

    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

    \n
    • \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
  • \n

    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool \n configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Validate the ClientMetadata value.

    \n
    • \n
  • \n

    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

    \n
    • \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
  • \n

    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool \n configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Validate the ClientMetadata value.

    \n
    • \n
  • \n

    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

    \n
    • \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
    \n
  • \n

    \n ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the \n ADMIN_NO_SRP_AUTH setting. With this authentication flow, Amazon Cognito receives the password in the request instead of using the Secure Remote Password (SRP) protocol to \n verify passwords.

    \n
    • \n
  • \n

    \n ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.

    \n
    • \n
  • \n

    \n ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP \n protocol to verify passwords.

    \n
    • \n
  • \n

    \n ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.

    \n
    • \n
  • \n

    \n ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.

    \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
    \n
  • \n

    \n ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password\n authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces\n the ADMIN_NO_SRP_AUTH setting. With this authentication flow, Amazon Cognito\n receives the password in the request instead of using the Secure Remote Password\n (SRP) protocol to verify passwords.

    \n
    • \n
  • \n

    \n ALLOW_CUSTOM_AUTH: Enable Lambda trigger based\n authentication.

    \n
    • \n
  • \n

    \n ALLOW_USER_PASSWORD_AUTH: Enable user password-based\n authentication. In this flow, Amazon Cognito receives the password in the request instead\n of using the SRP protocol to verify passwords.

    \n
    • \n
  • \n

    \n ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.

    \n
    • \n
  • \n

    \n ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh\n tokens.

    \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
    \n
  • \n

    If you specify COGNITO_DEFAULT, Amazon Cognito uses this address as the custom FROM address when it emails your users using its built-in email account.

    \n
    • \n
  • \n

    If you specify DEVELOPER, Amazon Cognito emails your users with this address by calling Amazon SES on your behalf.

    \n
    • \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
  • \n

    If you specify COGNITO_DEFAULT, Amazon Cognito uses this address as the custom FROM address when it emails your users using its built-in email account.

    \n
    • \n
  • \n

    If you specify DEVELOPER, Amazon Cognito emails your users with this address by calling Amazon SES on your behalf.

    \n
    • \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
    \n
  • \n

    Event publishing – Amazon Simple Email Service can track the number of send, delivery, open, click, bounce, and complaint events for each email sent. Use event publishing \n to send information about these events to other Amazon Web Services services such as and Amazon CloudWatch.

    \n
    • \n
  • \n

    IP pool management – When leasing dedicated IP addresses with Amazon Simple Email Service, you can create groups of IP addresses, called dedicated IP pools. You can then \n associate the dedicated IP pools with configuration sets.

    \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
  • \n

    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool \n configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Validate the ClientMetadata value.

    \n
    • \n
  • \n

    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

    \n
    • \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
  • \n

    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool \n configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Validate the ClientMetadata value.

    \n
    • \n
  • \n

    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

    \n
    • \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
  • \n

    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool \n configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Validate the ClientMetadata value.

    \n
    • \n
  • \n

    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

    \n
    • \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
  • \n

    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool \n configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Validate the ClientMetadata value.

    \n
    • \n
  • \n

    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

    \n
    • \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
  • \n

    Pre signup

    \n
    • \n
  • \n

    Pre authentication

    \n
    • \n
  • \n

    User migration

    \n
    • \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
  • \n

    Post authentication

    \n
    • \n
  • \n

    Custom message

    \n
    • \n
  • \n

    Pre token generation

    \n
    • \n
  • \n

    Create auth challenge

    \n
    • \n
  • \n

    Define auth challenge

    \n
    • \n
  • \n

    Verify auth challenge

    \n
    • \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
  • \n

    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration \n doesn't include triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Validate the ClientMetadata value.

    \n
    • \n
  • \n

    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

    \n
    • \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
  • \n

    Pre signup

    \n
    • \n
  • \n

    Pre authentication

    \n
    • \n
  • \n

    User migration

    \n
    • \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

    Post authentication

    \n
    • \n
  • \n

    Custom message

    \n
    • \n
  • \n

    Pre token generation

    \n
    • \n
  • \n

    Create auth challenge

    \n
    • \n
  • \n

    Define auth challenge

    \n
    • \n
  • \n

    Verify auth challenge

    \n
    • \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
  • \n

    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration \n doesn't include triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Validate the ClientMetadata value.

    \n
    • \n
  • \n

    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

    \n
    • \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
    \n
  • \n

    \n SMS_MFA: Next challenge is to supply an SMS_MFA_CODE, delivered via SMS.

    \n
    • \n
  • \n

    \n PASSWORD_VERIFIER: Next challenge is to supply PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after the \n client-side SRP calculations.

    \n
    • \n
  • \n

    \n CUSTOM_CHALLENGE: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued.

    \n
    • \n
  • \n

    \n DEVICE_SRP_AUTH: If device tracking was activated on your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking \n this device.

    \n
    • \n
  • \n

    \n DEVICE_PASSWORD_VERIFIER: Similar to PASSWORD_VERIFIER, but for devices only.

    \n
    • \n
  • \n

    \n NEW_PASSWORD_REQUIRED: For users who are required to change their passwords after successful first login. This challenge should be passed with NEW_PASSWORD \n and any other required attributes.

    \n
    • \n
  • \n

    \n MFA_SETUP: For users who are required to setup an MFA factor before they can sign in. The MFA types activated for the user pool will be listed in the challenge parameters \n MFA_CAN_SETUP value.

    \n

    To set up software token MFA, use the session returned here from InitiateAuth as an input to AssociateSoftwareToken. Use the session returned by \n VerifySoftwareToken as an input to RespondToAuthChallenge with challenge name MFA_SETUP to complete sign-in. To set up SMS MFA, an \n administrator should help the user to add a phone number to their account, and then the user should call InitiateAuth again to restart sign-in.

    \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
    \n
  • \n

    \n SMS_MFA: Next challenge is to supply an\n SMS_MFA_CODE, delivered via SMS.

    \n
    • \n
  • \n

    \n PASSWORD_VERIFIER: Next challenge is to supply\n PASSWORD_CLAIM_SIGNATURE,\n PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after\n the client-side SRP calculations.

    \n
    • \n
  • \n

    \n CUSTOM_CHALLENGE: This is returned if your custom authentication\n flow determines that the user should pass another challenge before tokens are\n issued.

    \n
    • \n
  • \n

    \n DEVICE_SRP_AUTH: If device tracking was activated on your user\n pool and the previous challenges were passed, this challenge is returned so that\n Amazon Cognito can start tracking this device.

    \n
    • \n
  • \n

    \n DEVICE_PASSWORD_VERIFIER: Similar to\n PASSWORD_VERIFIER, but for devices only.

    \n
    • \n
  • \n

    \n NEW_PASSWORD_REQUIRED: For users who are required to change their\n passwords after successful first login. This challenge should be passed with\n NEW_PASSWORD and any other required attributes.

    \n
    • \n
  • \n

    \n MFA_SETUP: For users who are required to setup an MFA factor\n before they can sign in. The MFA types activated for the user pool will be\n listed in the challenge parameters MFA_CAN_SETUP value.

    \n

    To set up software token MFA, use the session returned here from\n InitiateAuth as an input to\n AssociateSoftwareToken. Use the session returned by\n VerifySoftwareToken as an input to\n RespondToAuthChallenge with challenge name\n MFA_SETUP to complete sign-in. To set up SMS MFA, an\n administrator should help the user to add a phone number to their account, and\n then the user should call InitiateAuth again to restart\n sign-in.

    \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
  • \n

    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool \n configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Validate the ClientMetadata value.

    \n
    • \n
  • \n

    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

    \n
    • \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
  • \n

    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool \n configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Validate the ClientMetadata value.

    \n
    • \n
  • \n

    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

    \n
    • \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
  • \n

    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration \n doesn't include triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Validate the ClientMetadata value.

    \n
    • \n
  • \n

    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

    \n
    • \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
  • \n

    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration \n doesn't include triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Validate the ClientMetadata value.

    \n
    • \n
  • \n

    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

    \n
    • \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
    \n
  • \n

    \n OFF MFA won't be used for any users.

    \n
    • \n
  • \n

    \n ON MFA is required for all users to sign in.

    \n
    • \n
  • \n

    \n OPTIONAL MFA will be required only for individual users who have an MFA factor activated.

    \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
    \n
  • \n

    \n OFF MFA won't be used for any users.

    \n
    • \n
  • \n

    \n ON MFA is required for all users to sign in.

    \n
    • \n
  • \n

    \n OPTIONAL MFA will be required only for individual users who have an MFA factor activated.

    \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
  • \n

    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool \n configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Validate the ClientMetadata value.

    \n
    • \n
  • \n

    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

    \n
    • \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
  • \n

    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool \n configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Validate the ClientMetadata value.

    \n
    • \n
  • \n

    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

    \n
    • \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
  • \n

    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool \n configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Validate the ClientMetadata value.

    \n
    • \n
  • \n

    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

    \n
    • \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
  • \n

    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool \n configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Validate the ClientMetadata value.

    \n
    • \n
  • \n

    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

    \n
    • \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
    \n
  • \n

    InvalidSmsRoleAccessPolicyException - The Identity and Access Management role that Amazon Cognito uses to send SMS messages isn't properly configured. For more information, \n see SmsConfigurationType.

    \n
    • \n
  • \n

    SNSSandbox - \n The Amazon Web Services account is in SNS Sandbox and messages will only reach verified end users. This parameter won’t get populated with SNSSandbox if the IAM user creating the user pool \n doesn’t have SNS permissions. To learn how to move your Amazon Web Services account out of the sandbox, \n see Moving out of the SMS sandbox.

    \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
    \n
  • \n

    UNCONFIRMED - User has been created but not confirmed.

    \n
    • \n
  • \n

    CONFIRMED - User has been confirmed.

    \n
    • \n
  • \n

    ARCHIVED - User is no longer active.

    \n
    • \n
  • \n

    COMPROMISED - User is disabled due to a potential security threat.

    \n
    • \n
  • \n

    UNKNOWN - User status isn't known.

    \n
    • \n
  • \n

    RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.

    \n
    • \n
  • \n

    FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a \n new value before doing anything else.

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

The user status. This can be one of the following:

\n \n
    \n
  • \n

    UNCONFIRMED - User has been created but not confirmed.

    \n
    • \n
  • \n

    CONFIRMED - User has been confirmed.

    \n
    • \n
  • \n

    ARCHIVED - User is no longer active.

    \n
    • \n
  • \n

    UNKNOWN - User status isn't known.

    \n
    • \n
  • \n

    RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.

    \n
    • \n
  • \n

    FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a \n new value before doing anything else.

    \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
    \n
  • \n

    \n \n True\n : Enables case sensitivity for all username input. When this option is set to True, \n users must sign in using the exact capitalization of their given username, such as “UserName”. This is the default value.

    \n
    • \n
  • \n

    \n \n False\n : Enables case insensitivity for all username input. For example, when this option is set to \n False, users can sign in using either \"username\" or \"Username\". This option also enables both preferred_username and email \n alias to be case insensitive, in addition to the username attribute.

    \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/aws/sdk/aws-models/comprehend.json b/aws/sdk/aws-models/comprehend.json index 0b09849064..a63ca42840 100644 --- a/aws/sdk/aws-models/comprehend.json +++ b/aws/sdk/aws-models/comprehend.json @@ -908,6 +908,9 @@ { "target": "com.amazonaws.comprehend#DescribeSentimentDetectionJob" }, + { + "target": "com.amazonaws.comprehend#DescribeTargetedSentimentDetectionJob" + }, { "target": "com.amazonaws.comprehend#DescribeTopicsDetectionJob" }, @@ -971,6 +974,9 @@ { "target": "com.amazonaws.comprehend#ListTagsForResource" }, + { + "target": "com.amazonaws.comprehend#ListTargetedSentimentDetectionJobs" + }, { "target": "com.amazonaws.comprehend#ListTopicsDetectionJobs" }, @@ -998,6 +1004,9 @@ { "target": "com.amazonaws.comprehend#StartSentimentDetectionJob" }, + { + "target": "com.amazonaws.comprehend#StartTargetedSentimentDetectionJob" + }, { "target": "com.amazonaws.comprehend#StartTopicsDetectionJob" }, @@ -1019,6 +1028,9 @@ { "target": "com.amazonaws.comprehend#StopSentimentDetectionJob" }, + { + "target": "com.amazonaws.comprehend#StopTargetedSentimentDetectionJob" + }, { "target": "com.amazonaws.comprehend#StopTrainingDocumentClassifier" }, @@ -2216,6 +2228,55 @@ } } }, + "com.amazonaws.comprehend#DescribeTargetedSentimentDetectionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#DescribeTargetedSentimentDetectionJobRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#DescribeTargetedSentimentDetectionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#JobNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the properties associated with a targeted sentiment detection job. Use this operation \n to get the status of the job.

" + } + }, + "com.amazonaws.comprehend#DescribeTargetedSentimentDetectionJobRequest": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its\n response.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.comprehend#DescribeTargetedSentimentDetectionJobResponse": { + "type": "structure", + "members": { + "TargetedSentimentDetectionJobProperties": { + "target": "com.amazonaws.comprehend#TargetedSentimentDetectionJobProperties", + "traits": { + "smithy.api#documentation": "

An object that contains the properties associated with a targeted sentiment detection job.

" + } + } + } + }, "com.amazonaws.comprehend#DescribeTopicsDetectionJob": { "type": "operation", "input": { @@ -3762,7 +3823,7 @@ "F1Score": { "target": "com.amazonaws.comprehend#Double", "traits": { - "smithy.api#documentation": "

A measure of how accurate the recognizer results are for the test data. It is derived from\n the Precision and Recall values. The F1Score is the\n harmonic average of the two scores. The highest score is 1, and the worst score is 0.

" + "smithy.api#documentation": "

A measure of how accurate the recognizer results are for the test data. It is derived from\n the Precision and Recall values. The F1Score is the\n harmonic average of the two scores. For plain text entity recognizer models, the range is 0 to 100, \n where 100 is the best score. For PDF/Word entity recognizer models, the range is 0 to 1, \n where 1 is the best score. \n

" } } }, @@ -4727,7 +4788,7 @@ "min": 0, "max": 2048 }, - "smithy.api#pattern": ".*" + "smithy.api#pattern": "^\\p{ASCII}+$" } }, "com.amazonaws.comprehend#KmsKeyValidationException": { @@ -5777,6 +5838,77 @@ } } }, + "com.amazonaws.comprehend#ListTargetedSentimentDetectionJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#ListTargetedSentimentDetectionJobsRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#ListTargetedSentimentDetectionJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidFilterException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a list of targeted sentiment detection jobs that you have submitted.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.comprehend#ListTargetedSentimentDetectionJobsRequest": { + "type": "structure", + "members": { + "Filter": { + "target": "com.amazonaws.comprehend#TargetedSentimentDetectionJobFilter", + "traits": { + "smithy.api#documentation": "

Filters the jobs that are returned. You can filter jobs on their name, status, or the date\n and time that they were submitted. You can only set one filter at a time.

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

Identifies the next page of results to return.

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

The maximum number of results to return in each page. The default is 100.

" + } + } + } + }, + "com.amazonaws.comprehend#ListTargetedSentimentDetectionJobsResponse": { + "type": "structure", + "members": { + "TargetedSentimentDetectionJobPropertiesList": { + "target": "com.amazonaws.comprehend#TargetedSentimentDetectionJobPropertiesList", + "traits": { + "smithy.api#documentation": "

A list containing the properties of each job that is returned.

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

Identifies the next page of results to return.

" + } + } + } + }, "com.amazonaws.comprehend#ListTopicsDetectionJobs": { "type": "operation", "input": { @@ -5919,7 +6051,7 @@ "S3Uri": { "target": "com.amazonaws.comprehend#S3Uri", "traits": { - "smithy.api#documentation": "

When you use the OutputDataConfig object with asynchronous operations, you\n specify the Amazon S3 location where you want to write the output data. The URI must be in the\n same region as the API endpoint that you are calling. The location is used as the prefix for\n the actual location of the output file.

\n

When the topic detection job is finished, the service creates an output file in a\n directory specific to the job. The S3Uri field contains the location of the\n output file, called output.tar.gz. It is a compressed archive that contains the\n ouput of the operation.

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

When you use the OutputDataConfig object with asynchronous operations, you\n specify the Amazon S3 location where you want to write the output data. The URI must be in the\n same region as the API endpoint that you are calling. The location is used as the prefix for\n the actual location of the output file.

\n

When the topic detection job is finished, the service creates an output file in a\n directory specific to the job. The S3Uri field contains the location of the\n output file, called output.tar.gz. It is a compressed archive that contains the\n ouput of the operation.

\n

\n For a PII entity detection job, the output file is plain text, not a compressed archive. \n The output file name is the same as the input file, with .out appended at the end.\n

", "smithy.api#required": {} } }, @@ -5931,7 +6063,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides configuration parameters for the output of topic detection jobs.

\n

" + "smithy.api#documentation": "

Provides configuration parameters for the output of inference jobs.

\n

" } }, "com.amazonaws.comprehend#PartOfSpeechTag": { @@ -6324,7 +6456,7 @@ "S3Uri": { "target": "com.amazonaws.comprehend#S3Uri", "traits": { - "smithy.api#documentation": "

When you use the PiiOutputDataConfig object with asynchronous operations,\n you specify the Amazon S3 location where you want to write the output data.

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

When you use the PiiOutputDataConfig object with asynchronous operations,\n you specify the Amazon S3 location where you want to write the output data.

\n

\n For a PII entity detection job, the output file is plain text, not a compressed archive. \n The output file name is the same as the input file, with .out appended at the end.\n

", "smithy.api#required": {} } }, @@ -7451,7 +7583,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts an asynchronous sentiment detection job for a collection of documents. use the\n operation to track the status of a\n job.

" + "smithy.api#documentation": "

Starts an asynchronous sentiment detection job for a collection of documents. Use the\n operation to track the status of a\n job.

" } }, "com.amazonaws.comprehend#StartSentimentDetectionJobRequest": { @@ -7541,6 +7673,118 @@ } } }, + "com.amazonaws.comprehend#StartTargetedSentimentDetectionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#StartTargetedSentimentDetectionJobRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#StartTargetedSentimentDetectionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#KmsKeyValidationException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + }, + { + "target": "com.amazonaws.comprehend#TooManyTagsException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts an asynchronous targeted sentiment detection job for a collection of documents. Use the\n operation to track the status of a\n job.

" + } + }, + "com.amazonaws.comprehend#StartTargetedSentimentDetectionJobRequest": { + "type": "structure", + "members": { + "InputDataConfig": { + "target": "com.amazonaws.comprehend#InputDataConfig", + "traits": { + "smithy.api#required": {} + } + }, + "OutputDataConfig": { + "target": "com.amazonaws.comprehend#OutputDataConfig", + "traits": { + "smithy.api#documentation": "

Specifies where to send the output files.

", + "smithy.api#required": {} + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.

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

The identifier of the job.

" + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "

The language of the input documents. You can specify any of the primary languages\n supported by Amazon Comprehend. All documents must be in the same language.

", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.comprehend#ClientRequestTokenString", + "traits": { + "smithy.api#documentation": "

A unique identifier for the request. If you don't set the client request token, Amazon\n Comprehend generates one.

", + "smithy.api#idempotencyToken": {} + } + }, + "VolumeKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "

ID for the KMS key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:

\n
    \n
  • \n

    KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
" + } + }, + "VpcConfig": { + "target": "com.amazonaws.comprehend#VpcConfig" + }, + "Tags": { + "target": "com.amazonaws.comprehend#TagList", + "traits": { + "smithy.api#documentation": "

Tags to be associated with the targeted sentiment detection job. A tag is a key-value pair that\n adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the\n key might be added to a resource to indicate its use by the sales department.

" + } + } + } + }, + "com.amazonaws.comprehend#StartTargetedSentimentDetectionJobResponse": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier generated for the job. To get the status of a job, use this identifier with\n the operation.

" + } + }, + "JobArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the targeted sentiment detection job. It is a unique, fully\n qualified identifier for the job. It includes the AWS account, Region, and the job ID. The\n format of the ARN is as follows:

\n

\n arn::comprehend:::targeted-sentiment-detection-job/\n

\n

The following is an example job ARN:

\n

\n arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab\n

" + } + }, + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

The status of the job.

\n
    \n
  • \n

    SUBMITTED - The job has been received and is queued for processing.

    \n
    • \n
  • \n

    IN_PROGRESS - Amazon Comprehend is processing the job.

    \n
    • \n
  • \n

    COMPLETED - The job was successfully completed and the output is available.

    \n
    • \n
  • \n

    FAILED - The job did not complete. To get details, use the operation.

    \n
    • \n
" + } + } + } + }, "com.amazonaws.comprehend#StartTopicsDetectionJob": { "type": "operation", "input": { @@ -7968,6 +8212,58 @@ } } }, + "com.amazonaws.comprehend#StopTargetedSentimentDetectionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#StopTargetedSentimentDetectionJobRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#StopTargetedSentimentDetectionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#JobNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Stops a targeted sentiment detection job in progress.

\n

If the job state is IN_PROGRESS the job is marked for termination and put\n into the STOP_REQUESTED state. If the job completes before it can be stopped, it\n is put into the COMPLETED state; otherwise the job is be stopped and put into the\n STOPPED state.

\n

If the job is in the COMPLETED or FAILED state when you call the\n StopDominantLanguageDetectionJob operation, the operation returns a 400\n Internal Request Exception.

\n

When a job is stopped, any documents already processed are written to the output\n location.

" + } + }, + "com.amazonaws.comprehend#StopTargetedSentimentDetectionJobRequest": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier of the targeted sentiment detection job to stop.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.comprehend#StopTargetedSentimentDetectionJobResponse": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier of the targeted sentiment detection job to stop.

" + } + }, + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

Either STOP_REQUESTED if the job is currently running, or\n STOPPED if the job was previously stopped with the\n StopSentimentDetectionJob operation.

" + } + } + } + }, "com.amazonaws.comprehend#StopTrainingDocumentClassifier": { "type": "operation", "input": { @@ -8265,6 +8561,121 @@ } } }, + "com.amazonaws.comprehend#TargetedSentimentDetectionJobFilter": { + "type": "structure", + "members": { + "JobName": { + "target": "com.amazonaws.comprehend#JobName", + "traits": { + "smithy.api#documentation": "

Filters on the name of the job.

" + } + }, + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

Filters the list of jobs based on job status. Returns only jobs with the specified\n status.

" + } + }, + "SubmitTimeBefore": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted before the specified time. Jobs are returned in ascending order,\n oldest to newest.

" + } + }, + "SubmitTimeAfter": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted after the specified time. Jobs are returned in descending order,\n newest to oldest.

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

Provides information for filtering a list of dominant language detection jobs. For more\n information, see the operation.

" + } + }, + "com.amazonaws.comprehend#TargetedSentimentDetectionJobProperties": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier assigned to the targeted sentiment detection job.

" + } + }, + "JobArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the targeted sentiment detection job. It is a unique, fully\n qualified identifier for the job. It includes the AWS account, Region, and the job ID. The\n format of the ARN is as follows:

\n

\n arn::comprehend:::targeted-sentiment-detection-job/\n

\n

The following is an example job ARN:

\n

\n arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab\n

" + } + }, + "JobName": { + "target": "com.amazonaws.comprehend#JobName", + "traits": { + "smithy.api#documentation": "

The name that you assigned to the targeted sentiment detection job.

" + } + }, + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

The current status of the targeted sentiment detection job. If the status is FAILED,\n the Messages field shows the reason for the failure.

" + } + }, + "Message": { + "target": "com.amazonaws.comprehend#AnyLengthString", + "traits": { + "smithy.api#documentation": "

A description of the status of a job.

" + } + }, + "SubmitTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the targeted sentiment detection job was submitted for processing.

" + } + }, + "EndTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the targeted sentiment detection job ended.

" + } + }, + "InputDataConfig": { + "target": "com.amazonaws.comprehend#InputDataConfig" + }, + "OutputDataConfig": { + "target": "com.amazonaws.comprehend#OutputDataConfig" + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "

The language code of the input documents.

" + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input\n data.

" + } + }, + "VolumeKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the \n targeted sentiment detection job. The VolumeKmsKeyId can be either of the following formats:

\n
    \n
  • \n

    KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
" + } + }, + "VpcConfig": { + "target": "com.amazonaws.comprehend#VpcConfig" + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about a targeted sentiment detection job.

" + } + }, + "com.amazonaws.comprehend#TargetedSentimentDetectionJobPropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#TargetedSentimentDetectionJobProperties" + } + }, "com.amazonaws.comprehend#TextSizeLimitExceededException": { "type": "structure", "members": { diff --git a/aws/sdk/aws-models/config.json b/aws/sdk/aws-models/config.json index 2d3f33e389..f10699540c 100644 --- a/aws/sdk/aws-models/config.json +++ b/aws/sdk/aws-models/config.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/aws/sdk/aws-models/connect.json b/aws/sdk/aws-models/connect.json index dad49d41b9..2e5b5f1e2e 100644 --- a/aws/sdk/aws-models/connect.json +++ b/aws/sdk/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": {} } }, @@ -7337,6 +7337,10 @@ { "value": "AGENT_EVENTS", "name": "AGENT_EVENTS" + }, + { + "value": "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS", + "name": "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS" } ] } @@ -12930,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.

" + } } } }, @@ -12979,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

    If the API is called before the agent joins the call, recording starts when the agent joins the call.

    \n
    • \n
  • \n

    If the API is called after the agent joins the call, recording starts at the time of the API call.

    \n
    • \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", @@ -13380,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
    \n
  • \n

    CALLBACK

    \n
    • \n
  • \n

    DISCONNECT

    \n
    • \n
  • \n

    TRANSFER

    \n
    • \n
  • \n

    QUEUE_TRANSFER

    \n
    • \n
", "smithy.api#http": { "method": "POST", "uri": "/contact/stop", @@ -13565,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/aws/sdk/aws-models/dataexchange.json b/aws/sdk/aws-models/dataexchange.json index c4620d8ab3..084be901e8 100644 --- a/aws/sdk/aws-models/dataexchange.json +++ b/aws/sdk/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/aws/sdk/aws-models/devops-guru.json b/aws/sdk/aws-models/devops-guru.json index 74db84bada..2874844bc8 100644 --- a/aws/sdk/aws-models/devops-guru.json +++ b/aws/sdk/aws-models/devops-guru.json @@ -167,6 +167,20 @@ } } }, + "com.amazonaws.devopsguru#AmazonCodeGuruProfilerIntegration": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.devopsguru#EventSourceOptInStatus", + "traits": { + "smithy.api#documentation": "

The status of the CodeGuru Profiler integration.

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

Information about your account's integration with Amazon CodeGuru Profiler.

" + } + }, "com.amazonaws.devopsguru#AnomalyDescription": { "type": "string" }, @@ -227,7 +241,7 @@ } }, "traits": { - "smithy.api#documentation": "

The Amazon Web Services resources in which DevOps Guru detected unusual behavior that resulted in \n \tthe generation of an anomaly. When DevOps Guru detects multiple related anomalies, it creates \n and insight with details about the anomalous behavior and suggestions about how to correct the \n problem.

" + "smithy.api#documentation": "

The Amazon Web Services resources in which DevOps Guru detected unusual behavior that resulted in the\n\t\t\tgeneration of an anomaly. When DevOps Guru detects multiple related anomalies, it creates and\n\t\t\tinsight with details about the anomalous behavior and suggestions about how to correct\n\t\t\tthe problem.

" } }, "com.amazonaws.devopsguru#AnomalyResources": { @@ -255,6 +269,9 @@ ] } }, + "com.amazonaws.devopsguru#AnomalySource": { + "type": "string" + }, "com.amazonaws.devopsguru#AnomalySourceDetails": { "type": "structure", "members": { @@ -267,7 +284,7 @@ "PerformanceInsightsMetrics": { "target": "com.amazonaws.devopsguru#PerformanceInsightsMetricsDetails", "traits": { - "smithy.api#documentation": "

An array of PerformanceInsightsMetricsDetail objects that contain information\n \t\tabout analyzed Performance Insights metrics that show anomalous behavior.

" + "smithy.api#documentation": "

An array of PerformanceInsightsMetricsDetail objects that contain\n\t\t\tinformation about analyzed Performance Insights metrics that show anomalous behavior.

" } } }, @@ -275,6 +292,32 @@ "smithy.api#documentation": "

Details about the source of the anomalous operational data that triggered the\n\t\t\tanomaly.

" } }, + "com.amazonaws.devopsguru#AnomalySourceMetadata": { + "type": "structure", + "members": { + "Source": { + "target": "com.amazonaws.devopsguru#AnomalySource", + "traits": { + "smithy.api#documentation": "

The source of the anomaly.

" + } + }, + "SourceResourceName": { + "target": "com.amazonaws.devopsguru#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the anomaly's resource.

" + } + }, + "SourceResourceType": { + "target": "com.amazonaws.devopsguru#ResourceType", + "traits": { + "smithy.api#documentation": "

The anomaly's resource type.

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

Metadata about an anomaly. The anomaly is detected using analysis of the metric data\u2028 over a period of time

" + } + }, "com.amazonaws.devopsguru#AnomalyStatus": { "type": "string", "traits": { @@ -383,6 +426,9 @@ { "target": "com.amazonaws.devopsguru#DescribeAnomaly" }, + { + "target": "com.amazonaws.devopsguru#DescribeEventSourcesConfig" + }, { "target": "com.amazonaws.devopsguru#DescribeFeedback" }, @@ -443,6 +489,9 @@ { "target": "com.amazonaws.devopsguru#StartCostEstimation" }, + { + "target": "com.amazonaws.devopsguru#UpdateEventSourcesConfig" + }, { "target": "com.amazonaws.devopsguru#UpdateResourceCollection" }, @@ -566,7 +615,7 @@ "StatusCode": { "target": "com.amazonaws.devopsguru#CloudWatchMetricDataStatusCode", "traits": { - "smithy.api#documentation": "

This is an enum of the status showing whether the metric value pair list has partial or\n\t\t\tcomplete data, or if there was an error.

" + "smithy.api#documentation": "

This is an enum of the status showing whether the metric value pair list has partial\n\t\t\tor complete data, or if there was an error.

" } } }, @@ -758,7 +807,7 @@ "Tags": { "target": "com.amazonaws.devopsguru#TagCostEstimationResourceCollectionFilters", "traits": { - "smithy.api#documentation": "

The Amazon Web Services tags used to filter the resource collection that is used for \n \t\ta cost estimate.

\n \t

Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support\n \t\ttagging, so you can assign the same tag to resources from different services to indicate\n \t\tthat the resources are related. For example, you can assign the same tag to an Amazon DynamoDB\n \t\ttable resource that you assign to an Lambda function. For more information about\n \t\tusing tags, see the Tagging\n \t\t\tbest practices whitepaper.

\n \t

Each Amazon Web Services tag has two parts.

\n \t
    \n
  • \n \t\t\t

    A tag key (for example, CostCenter,\n \t\t\t\tEnvironment, Project, or Secret). Tag\n \t\t\t\tkeys are case-sensitive.

    \n \t\t
    • \n
  • \n \t\t\t

    An optional field known as a tag value (for example,\n \t\t\t\t111122223333, Production, or a team\n \t\t\t\tname). Omitting the tag value is the same as using an empty\n \t\t\t\tstring. Like tag keys, tag values are\n \t\t\t\tcase-sensitive.

    \n \t\t
    • \n
\n \t

Together these are known as key-value pairs.

\n \t \n\t\t

The string used for a key in a tag that you use to define your resource coverage must begin with the\n\t\t\tprefix Devops-guru-. The tag key might be\n\t\t\tDevops-guru-deployment-application or\n\t\t\tDevops-guru-rds-application. While keys are case-sensitive, the\n\t\t\tcase of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a\n\t\t\tkey named devops-guru-rds and a key named\n\t\t\tDevOps-Guru-RDS. Possible key/value pairs in your\n\t\t\tapplication might be Devops-Guru-production-application/RDS or\n\t\t\tDevops-Guru-production-application/containers.

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

The Amazon Web Services tags used to filter the resource collection that is used for a cost\n\t\t\testimate.

\n

Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support\n \t\ttagging, so you can assign the same tag to resources from different services to indicate\n \t\tthat the resources are related. For example, you can assign the same tag to an Amazon DynamoDB\n \t\ttable resource that you assign to an Lambda function. For more information about\n \t\tusing tags, see the Tagging\n \t\t\tbest practices whitepaper.

\n \t

Each Amazon Web Services tag has two parts.

\n \t
    \n
  • \n \t\t\t

    A tag key (for example, CostCenter,\n \t\t\t\tEnvironment, Project, or Secret). Tag\n \t\t\t\tkeys are case-sensitive.

    \n \t\t
    • \n
  • \n \t\t\t

    An optional field known as a tag value (for example,\n \t\t\t\t111122223333, Production, or a team\n \t\t\t\tname). Omitting the tag value is the same as using an empty\n \t\t\t\tstring. Like tag keys, tag values are\n \t\t\t\tcase-sensitive.

    \n \t\t
    • \n
\n \t

Together these are known as key-value pairs.

\n \t \n\t\t

The string used for a key in a tag that you use to define your resource coverage must begin with the\n\t\t\tprefix Devops-guru-. The tag key might be\n\t\t\tDevops-guru-deployment-application or\n\t\t\tDevops-guru-rds-application. While keys are case-sensitive, the\n\t\t\tcase of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a\n\t\t\tkey named devops-guru-rds and a key named\n\t\t\tDevOps-Guru-RDS. Possible key/value pairs in your\n\t\t\tapplication might be Devops-Guru-production-application/RDS or\n\t\t\tDevops-Guru-production-application/containers.

\n\t " } } }, @@ -1057,6 +1106,52 @@ } } }, + "com.amazonaws.devopsguru#DescribeEventSourcesConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.devopsguru#DescribeEventSourcesConfigRequest" + }, + "output": { + "target": "com.amazonaws.devopsguru#DescribeEventSourcesConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.devopsguru#AccessDeniedException" + }, + { + "target": "com.amazonaws.devopsguru#InternalServerException" + }, + { + "target": "com.amazonaws.devopsguru#ThrottlingException" + }, + { + "target": "com.amazonaws.devopsguru#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

This operation lists details about a DevOps Guru event source that is shared with your\u2028 account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/event-sources", + "code": 200 + } + } + }, + "com.amazonaws.devopsguru#DescribeEventSourcesConfigRequest": { + "type": "structure", + "members": {} + }, + "com.amazonaws.devopsguru#DescribeEventSourcesConfigResponse": { + "type": "structure", + "members": { + "EventSources": { + "target": "com.amazonaws.devopsguru#EventSourcesConfig", + "traits": { + "smithy.api#documentation": "

The name of the event source.

" + } + } + } + }, "com.amazonaws.devopsguru#DescribeFeedback": { "type": "operation", "input": { @@ -1419,7 +1514,7 @@ "CloudFormation": { "target": "com.amazonaws.devopsguru#CloudFormationHealths", "traits": { - "smithy.api#documentation": "

The returned CloudFormationHealthOverview object that contains an\n\t\t\tInsightHealthOverview object with the requested system health\n\t\t\tinformation.

" + "smithy.api#documentation": "

The returned CloudFormationHealthOverview object that contains an\n\t\t\t\tInsightHealthOverview object with the requested system health\n\t\t\tinformation.

" } }, "Service": { @@ -1527,7 +1622,7 @@ "Tags": { "target": "com.amazonaws.devopsguru#TagHealths", "traits": { - "smithy.api#documentation": "

The Amazon Web Services tags that are used by resources in the resource collection.

\n \t

Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support\n \t\ttagging, so you can assign the same tag to resources from different services to indicate\n \t\tthat the resources are related. For example, you can assign the same tag to an Amazon DynamoDB\n \t\ttable resource that you assign to an Lambda function. For more information about\n \t\tusing tags, see the Tagging\n \t\t\tbest practices whitepaper.

\n \t

Each Amazon Web Services tag has two parts.

\n \t
    \n
  • \n \t\t\t

    A tag key (for example, CostCenter,\n \t\t\t\tEnvironment, Project, or Secret). Tag\n \t\t\t\tkeys are case-sensitive.

    \n \t\t
    • \n
  • \n \t\t\t

    An optional field known as a tag value (for example,\n \t\t\t\t111122223333, Production, or a team\n \t\t\t\tname). Omitting the tag value is the same as using an empty\n \t\t\t\tstring. Like tag keys, tag values are\n \t\t\t\tcase-sensitive.

    \n \t\t
    • \n
\n \t

Together these are known as key-value pairs.

\n \t \n\t\t

The string used for a key in a tag that you use to define your resource coverage must begin with the\n\t\t\tprefix Devops-guru-. The tag key might be\n\t\t\tDevops-guru-deployment-application or\n\t\t\tDevops-guru-rds-application. While keys are case-sensitive, the\n\t\t\tcase of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a\n\t\t\tkey named devops-guru-rds and a key named\n\t\t\tDevOps-Guru-RDS. Possible key/value pairs in your\n\t\t\tapplication might be Devops-Guru-production-application/RDS or\n\t\t\tDevops-Guru-production-application/containers.

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

The Amazon Web Services tags that are used by resources in the resource collection.

\n\t\t

Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support\n \t\ttagging, so you can assign the same tag to resources from different services to indicate\n \t\tthat the resources are related. For example, you can assign the same tag to an Amazon DynamoDB\n \t\ttable resource that you assign to an Lambda function. For more information about\n \t\tusing tags, see the Tagging\n \t\t\tbest practices whitepaper.

\n \t

Each Amazon Web Services tag has two parts.

\n \t
    \n
  • \n \t\t\t

    A tag key (for example, CostCenter,\n \t\t\t\tEnvironment, Project, or Secret). Tag\n \t\t\t\tkeys are case-sensitive.

    \n \t\t
    • \n
  • \n \t\t\t

    An optional field known as a tag value (for example,\n \t\t\t\t111122223333, Production, or a team\n \t\t\t\tname). Omitting the tag value is the same as using an empty\n \t\t\t\tstring. Like tag keys, tag values are\n \t\t\t\tcase-sensitive.

    \n \t\t
    • \n
\n \t

Together these are known as key-value pairs.

\n \t \n\t\t

The string used for a key in a tag that you use to define your resource coverage must begin with the\n\t\t\tprefix Devops-guru-. The tag key might be\n\t\t\tDevops-guru-deployment-application or\n\t\t\tDevops-guru-rds-application. While keys are case-sensitive, the\n\t\t\tcase of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a\n\t\t\tkey named devops-guru-rds and a key named\n\t\t\tDevOps-Guru-RDS. Possible key/value pairs in your\n\t\t\tapplication might be Devops-Guru-production-application/RDS or\n\t\t\tDevops-Guru-production-application/containers.

\n\t " } } } @@ -1786,6 +1881,35 @@ "smithy.api#pattern": "^[a-z]+[a-z0-9]*\\.amazonaws\\.com|aws\\.events$" } }, + "com.amazonaws.devopsguru#EventSourceOptInStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ENABLED", + "name": "ENABLED" + }, + { + "value": "DISABLED", + "name": "DISABLED" + } + ] + } + }, + "com.amazonaws.devopsguru#EventSourcesConfig": { + "type": "structure", + "members": { + "AmazonCodeGuruProfiler": { + "target": "com.amazonaws.devopsguru#AmazonCodeGuruProfilerIntegration", + "traits": { + "smithy.api#documentation": "

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

Describes the event sources.

" + } + }, "com.amazonaws.devopsguru#EventTimeRange": { "type": "structure", "members": { @@ -1980,6 +2104,9 @@ } } }, + "com.amazonaws.devopsguru#InsightDescription": { + "type": "string" + }, "com.amazonaws.devopsguru#InsightFeedback": { "type": "structure", "members": { @@ -3115,13 +3242,13 @@ "Group": { "target": "com.amazonaws.devopsguru#PerformanceInsightsMetricGroup", "traits": { - "smithy.api#documentation": "

The name of the dimension group. Its valid values are:

\n \t\n \t
    \n
  • \n \t\t\t

    \n \t\t\t\t db - The name of the database to which the client is connected (only Aurora PostgreSQL, Amazon RDS PostgreSQL,\n \t\t\t\tAurora MySQL, Amazon RDS MySQL, and MariaDB)

    \n \t\t
    • \n
  • \n \t\t\t

    \n \t\t\t\t db.application - The name of the application that is connected to the database (only Aurora\n \t\t\t\tPostgreSQL and RDS PostgreSQL)

    \n \t\t
    • \n
  • \n \t\t\t

    \n \t\t\t\t db.host - The host name of the connected client (all engines)

    \n \t\t
    • \n
  • \n \t\t\t

    \n \t\t\t\t db.session_type - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)

    \n \t\t
    • \n
  • \n \t\t\t

    \n \t\t\t\t db.sql - The SQL that is currently executing (all engines)

    \n \t\t
    • \n
  • \n \t\t\t

    \n \t\t\t\t db.sql_tokenized - The SQL digest (all engines)

    \n \t\t
    • \n
  • \n \t\t\t

    \n \t\t\t\t db.wait_event - The event for which the database backend is waiting (all engines)

    \n \t\t
    • \n
  • \n \t\t\t

    \n \t\t\t\t db.wait_event_type - The type of event for which the database backend is waiting (all engines)

    \n \t\t
    • \n
  • \n \t\t\t

    \n \t\t\t\t db.user - The user logged in to the database (all engines)

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

The name of the dimension group. Its valid values are:

\n\n\t\t
    \n
  • \n\t\t\t\t

    \n\t\t\t\t\t db - The name of the database to which the client is connected\n\t\t\t\t\t(only Aurora PostgreSQL, Amazon RDS PostgreSQL, Aurora MySQL, Amazon RDS MySQL, and MariaDB)

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n\t\t\t\t\t db.application - The name of the application that is connected to\n\t\t\t\t\tthe database (only Aurora PostgreSQL and RDS PostgreSQL)

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n\t\t\t\t\t db.host - The host name of the connected client (all\n\t\t\t\t\tengines)

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n\t\t\t\t\t db.session_type - The type of the current session (only Aurora PostgreSQL\n\t\t\t\t\tand RDS PostgreSQL)

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n\t\t\t\t\t db.sql - The SQL that is currently executing (all engines)

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n\t\t\t\t\t db.sql_tokenized - The SQL digest (all engines)

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n\t\t\t\t\t db.wait_event - The event for which the database backend is waiting\n\t\t\t\t\t(all engines)

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n\t\t\t\t\t db.wait_event_type - The type of event for which the database\n\t\t\t\t\tbackend is waiting (all engines)

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n\t\t\t\t\t db.user - The user logged in to the database (all engines)

    \n\t\t\t
    • \n
" } }, "Dimensions": { "target": "com.amazonaws.devopsguru#PerformanceInsightsMetricDimensions", "traits": { - "smithy.api#documentation": "

A list of specific dimensions from a dimension group. If this parameter is not present,\n \t\tthen it signifies that all of the dimensions in the group were requested or are present in\n \t\tthe response.

\n \t

Valid values for elements in the Dimensions array are:

\n \t\n \t
    \n
  • \n \t\t\t

    \n \t\t\t\t db.application.name - The name of the application that is connected to the database (only\n \t\t\t\tAurora PostgreSQL and RDS PostgreSQL)

    \n \t\t
    • \n
  • \n \t\t\t

    \n \t\t\t\t db.host.id - The host ID of the connected client (all engines)

    \n \t\t
    • \n
  • \n \t\t\t

    \n \t\t\t\t db.host.name - The host name of the connected client (all engines)

    \n \t\t
    • \n
  • \n \t\t\t

    \n \t\t\t\t db.name - The name of the database to which the client is connected (only Aurora PostgreSQL, Amazon RDS\n \t\t\t\tPostgreSQL, Aurora MySQL, Amazon RDS MySQL, and MariaDB)

    \n \t\t
    • \n
  • \n \t\t\t

    \n \t\t\t\t db.session_type.name - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)

    \n \t\t
    • \n
  • \n \t\t\t

    \n \t\t\t\t db.sql.id - The SQL ID generated by Performance Insights (all engines)

    \n \t\t
    • \n
  • \n \t\t\t

    \n \t\t\t\t db.sql.db_id - The SQL ID generated by the database (all engines)

    \n \t\t
    • \n
  • \n \t\t\t

    \n \t\t\t\t db.sql.statement - The SQL text that is being executed (all engines)

    \n \t\t
    • \n
  • \n \t\t\t

    \n \t\t\t\t db.sql.tokenized_id\n \t\t\t

    \n \t\t
    • \n
  • \n \t\t\t

    \n \t\t\t\t db.sql_tokenized.id - The SQL digest ID generated by Performance Insights (all engines)

    \n \t\t
    • \n
  • \n \t\t\t

    \n \t\t\t\t db.sql_tokenized.db_id - SQL digest ID generated by the database (all engines)

    \n \t\t
    • \n
  • \n \t\t\t

    \n \t\t\t\t db.sql_tokenized.statement - The SQL digest text (all engines)

    \n \t\t
    • \n
  • \n \t\t\t

    \n \t\t\t\t db.user.id - The ID of the user logged in to the database (all engines)

    \n \t\t
    • \n
  • \n \t\t\t

    \n \t\t\t\t db.user.name - The name of the user logged in to the database (all engines)

    \n \t\t
    • \n
  • \n \t\t\t

    \n \t\t\t\t db.wait_event.name - The event for which the backend is waiting (all engines)

    \n \t\t
    • \n
  • \n \t\t\t

    \n \t\t\t\t db.wait_event.type - The type of event for which the backend is waiting (all engines)

    \n \t\t
    • \n
  • \n \t\t\t

    \n \t\t\t\t db.wait_event_type.name - The name of the event type for which the backend is waiting (all\n \t\t\t\tengines)

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

A list of specific dimensions from a dimension group. If this parameter is not\n\t\t\tpresent, then it signifies that all of the dimensions in the group were requested or are\n\t\t\tpresent in the response.

\n\t\t

Valid values for elements in the Dimensions array are:

\n\n\t\t
    \n
  • \n\t\t\t\t

    \n\t\t\t\t\t db.application.name - The name of the application that is connected\n\t\t\t\t\tto the database (only Aurora PostgreSQL and RDS PostgreSQL)

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n\t\t\t\t\t db.host.id - The host ID of the connected client (all\n\t\t\t\t\tengines)

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n\t\t\t\t\t db.host.name - The host name of the connected client (all\n\t\t\t\t\tengines)

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n\t\t\t\t\t db.name - The name of the database to which the client is connected\n\t\t\t\t\t(only Aurora PostgreSQL, Amazon RDS PostgreSQL, Aurora MySQL, Amazon RDS MySQL, and MariaDB)

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n\t\t\t\t\t db.session_type.name - The type of the current session (only Aurora\n\t\t\t\t\tPostgreSQL and RDS PostgreSQL)

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n\t\t\t\t\t db.sql.id - The SQL ID generated by Performance Insights (all engines)

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n\t\t\t\t\t db.sql.db_id - The SQL ID generated by the database (all\n\t\t\t\t\tengines)

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n\t\t\t\t\t db.sql.statement - The SQL text that is being executed (all\n\t\t\t\t\tengines)

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n\t\t\t\t\t db.sql.tokenized_id\n\t\t\t\t

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n\t\t\t\t\t db.sql_tokenized.id - The SQL digest ID generated by Performance Insights (all\n\t\t\t\t\tengines)

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n\t\t\t\t\t db.sql_tokenized.db_id - SQL digest ID generated by the database\n\t\t\t\t\t(all engines)

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n\t\t\t\t\t db.sql_tokenized.statement - The SQL digest text (all\n\t\t\t\t\tengines)

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n\t\t\t\t\t db.user.id - The ID of the user logged in to the database (all\n\t\t\t\t\tengines)

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n\t\t\t\t\t db.user.name - The name of the user logged in to the database (all\n\t\t\t\t\tengines)

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n\t\t\t\t\t db.wait_event.name - The event for which the backend is waiting\n\t\t\t\t\t(all engines)

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n\t\t\t\t\t db.wait_event.type - The type of event for which the backend is\n\t\t\t\t\twaiting (all engines)

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n\t\t\t\t\t db.wait_event_type.name - The name of the event type for which the\n\t\t\t\t\tbackend is waiting (all engines)

    \n\t\t\t
    • \n
" } }, "Limit": { @@ -3132,7 +3259,7 @@ } }, "traits": { - "smithy.api#documentation": "

A logical grouping of Performance Insights metrics for a related subject area. For example, the\n \t\tdb.sql dimension group consists of the following dimensions:\n \t\tdb.sql.id, db.sql.db_id, db.sql.statement, and\n \t\tdb.sql.tokenized_id.

\n \t \n \t\t

Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, \n \t\t\tonly the first 500 bytes are returned.

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

Amazon RDS Performance Insights enables you to monitor and explore different \n \t\tdimensions of database load based on data captured from a running DB instance. \n \t\tDB load is measured as average active sessions. Performance Insights provides the \n \t\tdata to API consumers as a two-dimensional time-series dataset. The time dimension \n \t\tprovides DB load data for each time point in the queried time range. Each time point \n \t\tdecomposes overall load in relation to the requested dimensions, measured at that \n \t\ttime point. Examples include SQL, Wait event, User, and Host.

\n \t\n \t
    \n
  • \n \t\t\t

    To learn more about Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora User Guide.\n \t\t\t

    \n \t\t
    • \n
  • \n \t\t\t

    To learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide.\n \t\t\t

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

A logical grouping of Performance Insights metrics for a related subject area. For example, the\n\t\t\t\tdb.sql dimension group consists of the following dimensions:\n\t\t\t\tdb.sql.id, db.sql.db_id, db.sql.statement,\n\t\t\tand db.sql.tokenized_id.

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

Each response element returns a maximum of 500 bytes. For larger elements, such as\n\t\t\t\tSQL statements, only the first 500 bytes are returned.

\n\t\t \n

Amazon RDS Performance Insights enables you to monitor and explore different \n \t\tdimensions of database load based on data captured from a running DB instance. \n \t\tDB load is measured as average active sessions. Performance Insights provides the \n \t\tdata to API consumers as a two-dimensional time-series dataset. The time dimension \n \t\tprovides DB load data for each time point in the queried time range. Each time point \n \t\tdecomposes overall load in relation to the requested dimensions, measured at that \n \t\ttime point. Examples include SQL, Wait event, User, and Host.

\n \t\n \t
    \n
  • \n \t\t\t

    To learn more about Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora User Guide.\n \t\t\t

    \n \t\t
    • \n
  • \n \t\t\t

    To learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide.\n \t\t\t

    \n \t\t
    • \n
" } }, "com.amazonaws.devopsguru#PerformanceInsightsMetricDimensions": { @@ -3181,24 +3308,24 @@ "Metric": { "target": "com.amazonaws.devopsguru#PerformanceInsightsMetricName", "traits": { - "smithy.api#documentation": "

The name of the meteric used used when querying an Performance Insights GetResourceMetrics API for \n \tanomaly metrics.

\n \t\n \t

Valid values for Metric are:

\n \t\n \t
    \n
  • \n \t\t\t

    \n \t\t\t\t db.load.avg - a scaled representation of the number of active sessions\n \t\t\t\tfor the database engine.

    \n \t\t
    • \n
  • \n \t\t\t

    \n \t\t\t\t db.sampledload.avg - the raw number of active sessions for the\n \t\t\t\tdatabase engine.

    \n \t\t
    • \n
\n \t

If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg \n \t\tare the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg \n \t\tshowing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. \n \t\tFor most use cases, you can query db.load.avg only.

" + "smithy.api#documentation": "

The name of the meteric used used when querying an Performance Insights\n\t\t\t\tGetResourceMetrics API for anomaly metrics.

\n\n\t\t

Valid values for Metric are:

\n\n\t\t
    \n
  • \n\t\t\t\t

    \n\t\t\t\t\t db.load.avg - a scaled representation of the number of active sessions for the\n\t\t\t\t\tdatabase engine.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n\t\t\t\t\t db.sampledload.avg - the raw number of active sessions for the database\n\t\t\t\t\tengine.

    \n\t\t\t
    • \n
\n\t\t

If the number of active sessions is less than an internal Performance Insights threshold,\n\t\t\t\tdb.load.avg and db.sampledload.avg are the same value. If\n\t\t\tthe number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with\n\t\t\t\tdb.load.avg showing the scaled values, db.sampledload.avg\n\t\t\tshowing the raw values, and db.sampledload.avg less than\n\t\t\t\tdb.load.avg. For most use cases, you can query db.load.avg\n\t\t\tonly.

" } }, "GroupBy": { "target": "com.amazonaws.devopsguru#PerformanceInsightsMetricDimensionGroup", "traits": { - "smithy.api#documentation": "

The specification for how to aggregate the data points from a Performance Insights GetResourceMetrics API query. The \n \t\tPerformance Insights query returns all of the dimensions within that group,\n \t\tunless you provide the names of specific dimensions within that group. You can also request\n \t\tthat Performance Insights return a limited number of values for a dimension.

" + "smithy.api#documentation": "

The specification for how to aggregate the data points from a Performance Insights\n\t\t\t\tGetResourceMetrics API query. The Performance Insights query returns all of the\n\t\t\tdimensions within that group, unless you provide the names of specific dimensions within\n\t\t\tthat group. You can also request that Performance Insights return a limited number of values for a\n\t\t\tdimension.

" } }, "Filter": { "target": "com.amazonaws.devopsguru#PerformanceInsightsMetricFilterMap", "traits": { - "smithy.api#documentation": "

One or more filters to apply to a Performance Insights GetResourceMetrics API query. Restrictions:

\n \t
    \n
  • \n \t\t\t

    Any number of filters by the same dimension, as specified in the GroupBy parameter.

    \n \t\t
    • \n
  • \n \t\t\t

    A single filter for any other dimension in this dimension group.

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

One or more filters to apply to a Performance Insights GetResourceMetrics API query.\n\t\t\tRestrictions:

\n\t\t
    \n
  • \n\t\t\t\t

    Any number of filters by the same dimension, as specified in the\n\t\t\t\t\t\tGroupBy parameter.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    A single filter for any other dimension in this dimension group.

    \n\t\t\t
    • \n
" } } }, "traits": { - "smithy.api#documentation": "

A single query to be processed. Use these parameters to \n \t\tquery the Performance Insights GetResourceMetrics API to retrieve the metrics \n \t\tfor an anomaly. For more information, see \n GetResourceMetrics\n \n \tin the Amazon RDS Performance Insights API Reference.

\n \t\n \t

Amazon RDS Performance Insights enables you to monitor and explore different \n \t\tdimensions of database load based on data captured from a running DB instance. \n \t\tDB load is measured as average active sessions. Performance Insights provides the \n \t\tdata to API consumers as a two-dimensional time-series dataset. The time dimension \n \t\tprovides DB load data for each time point in the queried time range. Each time point \n \t\tdecomposes overall load in relation to the requested dimensions, measured at that \n \t\ttime point. Examples include SQL, Wait event, User, and Host.

\n \t\n \t
    \n
  • \n \t\t\t

    To learn more about Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora User Guide.\n \t\t\t

    \n \t\t
    • \n
  • \n \t\t\t

    To learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide.\n \t\t\t

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

A single query to be processed. Use these parameters to query the Performance Insights\n\t\t\t\tGetResourceMetrics API to retrieve the metrics for an anomaly. For more\n\t\t\tinformation, see \n GetResourceMetrics\n in the Amazon RDS Performance Insights API\n\t\t\t\tReference.

\n

Amazon RDS Performance Insights enables you to monitor and explore different \n \t\tdimensions of database load based on data captured from a running DB instance. \n \t\tDB load is measured as average active sessions. Performance Insights provides the \n \t\tdata to API consumers as a two-dimensional time-series dataset. The time dimension \n \t\tprovides DB load data for each time point in the queried time range. Each time point \n \t\tdecomposes overall load in relation to the requested dimensions, measured at that \n \t\ttime point. Examples include SQL, Wait event, User, and Host.

\n \t\n \t
    \n
  • \n \t\t\t

    To learn more about Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora User Guide.\n \t\t\t

    \n \t\t
    • \n
  • \n \t\t\t

    To learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide.\n \t\t\t

    \n \t\t
    • \n
" } }, "com.amazonaws.devopsguru#PerformanceInsightsMetricUnit": { @@ -3222,13 +3349,13 @@ "MetricQuery": { "target": "com.amazonaws.devopsguru#PerformanceInsightsMetricQuery", "traits": { - "smithy.api#documentation": "

A single query to be processed for the metric. For more information, see \n \t\t\n PerformanceInsightsMetricQuery\n .

" + "smithy.api#documentation": "

A single query to be processed for the metric. For more information, see \n PerformanceInsightsMetricQuery\n .

" } }, "ReferenceData": { "target": "com.amazonaws.devopsguru#PerformanceInsightsReferenceDataList", "traits": { - "smithy.api#documentation": "

\n \tFor more information, see \n \t\n PerformanceInsightsReferenceData\n .\n

" + "smithy.api#documentation": "

For more information, see \n PerformanceInsightsReferenceData\n .

" } }, "StatsAtAnomaly": { @@ -3245,7 +3372,7 @@ } }, "traits": { - "smithy.api#documentation": "

Details about Performance Insights metrics.

\n \t\n \t

Amazon RDS Performance Insights enables you to monitor and explore different \n \t\tdimensions of database load based on data captured from a running DB instance. \n \t\tDB load is measured as average active sessions. Performance Insights provides the \n \t\tdata to API consumers as a two-dimensional time-series dataset. The time dimension \n \t\tprovides DB load data for each time point in the queried time range. Each time point \n \t\tdecomposes overall load in relation to the requested dimensions, measured at that \n \t\ttime point. Examples include SQL, Wait event, User, and Host.

\n \t\n \t
    \n
  • \n \t\t\t

    To learn more about Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora User Guide.\n \t\t\t

    \n \t\t
    • \n
  • \n \t\t\t

    To learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide.\n \t\t\t

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

Details about Performance Insights metrics.

\n

Amazon RDS Performance Insights enables you to monitor and explore different \n \t\tdimensions of database load based on data captured from a running DB instance. \n \t\tDB load is measured as average active sessions. Performance Insights provides the \n \t\tdata to API consumers as a two-dimensional time-series dataset. The time dimension \n \t\tprovides DB load data for each time point in the queried time range. Each time point \n \t\tdecomposes overall load in relation to the requested dimensions, measured at that \n \t\ttime point. Examples include SQL, Wait event, User, and Host.

\n \t\n \t
    \n
  • \n \t\t\t

    To learn more about Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora User Guide.\n \t\t\t

    \n \t\t
    • \n
  • \n \t\t\t

    To learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide.\n \t\t\t

    \n \t\t
    • \n
" } }, "com.amazonaws.devopsguru#PerformanceInsightsMetricsDetails": { @@ -3260,18 +3387,18 @@ "ReferenceScalar": { "target": "com.amazonaws.devopsguru#PerformanceInsightsReferenceScalar", "traits": { - "smithy.api#documentation": "

A scalar value DevOps Guru for a metric that DevOps Guru compares to actual metric values. This reference value is used \n to determine if an actual metric value should be considered anomalous.

" + "smithy.api#documentation": "

A scalar value DevOps Guru for a metric that DevOps Guru compares to actual metric values. This\n\t\t\treference value is used to determine if an actual metric value should be considered\n\t\t\tanomalous.

" } }, "ReferenceMetric": { "target": "com.amazonaws.devopsguru#PerformanceInsightsReferenceMetric", "traits": { - "smithy.api#documentation": "

A metric that DevOps Guru compares to actual metric values. This reference metric is used \n \t\tto determine if an actual metric should be considered anomalous.

" + "smithy.api#documentation": "

A metric that DevOps Guru compares to actual metric values. This reference metric is used to\n\t\t\tdetermine if an actual metric should be considered anomalous.

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

Reference scalar values and other metrics that DevOps Guru displays on a graph in its console along with the actual metrics it \n analyzed. Compare these reference values to your actual metrics to help you understand anomalous behavior that DevOps Guru detected.

" + "smithy.api#documentation": "

Reference scalar values and other metrics that DevOps Guru displays on a graph in its\n\t\t\tconsole along with the actual metrics it analyzed. Compare these reference values to\n\t\t\tyour actual metrics to help you understand anomalous behavior that DevOps Guru\n\t\t\tdetected.

" } }, "com.amazonaws.devopsguru#PerformanceInsightsReferenceData": { @@ -3286,12 +3413,12 @@ "ComparisonValues": { "target": "com.amazonaws.devopsguru#PerformanceInsightsReferenceComparisonValues", "traits": { - "smithy.api#documentation": "

The specific reference values used to evaluate the Performance Insights. For more information, see \n\t\t\t\n PerformanceInsightsReferenceComparisonValues\n .\n\t\t

" + "smithy.api#documentation": "

The specific reference values used to evaluate the Performance Insights. For more information, see\n\t\t\t\t\t\n PerformanceInsightsReferenceComparisonValues\n .

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

Reference data used to evaluate Performance Insights to determine if its performance \n is anomalous or not.

" + "smithy.api#documentation": "

Reference data used to evaluate Performance Insights to determine if its performance is anomalous or\n\t\t\tnot.

" } }, "com.amazonaws.devopsguru#PerformanceInsightsReferenceDataList": { @@ -3328,7 +3455,7 @@ } }, "traits": { - "smithy.api#documentation": "

A reference value to compare Performance Insights metrics against to determine if the metrics \n demonstrate anomalous behavior.

" + "smithy.api#documentation": "

A reference value to compare Performance Insights metrics against to determine if the metrics\n\t\t\tdemonstrate anomalous behavior.

" } }, "com.amazonaws.devopsguru#PerformanceInsightsStat": { @@ -3452,6 +3579,18 @@ "traits": { "smithy.api#documentation": "

A threshold that was exceeded by behavior in analyzed resources. Exceeding this\n\t\t\tthreshold is related to the anomalous behavior that generated this anomaly.

" } + }, + "SourceMetadata": { + "target": "com.amazonaws.devopsguru#AnomalySourceMetadata", + "traits": { + "smithy.api#documentation": "

The metadata for the anomaly.

" + } + }, + "AnomalyResources": { + "target": "com.amazonaws.devopsguru#AnomalyResources", + "traits": { + "smithy.api#documentation": "

Information about a resource in which DevOps Guru detected anomalous behavior.

" + } } }, "traits": { @@ -3517,6 +3656,18 @@ "traits": { "smithy.api#documentation": "

A threshold that was exceeded by behavior in analyzed resources. Exceeding this\n\t\t\tthreshold is related to the anomalous behavior that generated this anomaly.

" } + }, + "SourceMetadata": { + "target": "com.amazonaws.devopsguru#AnomalySourceMetadata", + "traits": { + "smithy.api#documentation": "

Returns the metadata of the source.

" + } + }, + "AnomalyResources": { + "target": "com.amazonaws.devopsguru#AnomalyResources", + "traits": { + "smithy.api#documentation": "

Information about a resource in which DevOps Guru detected anomalous behavior.

" + } } }, "traits": { @@ -3564,6 +3715,12 @@ "traits": { "smithy.api#documentation": "

The ID of the Amazon Web Services System Manager OpsItem created for this insight. You must enable\n\t\t\tthe creation of OpstItems insights before they are created for each insight.

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

Describes the proactive insight.

" + } } }, "traits": { @@ -3659,7 +3816,7 @@ "Severity": { "target": "com.amazonaws.devopsguru#InsightSeverity", "traits": { - "smithy.api#documentation": "

An array of severity values used to search for insights. For more information, see \n\tUnderstanding \n\tinsight severities in the Amazon DevOps Guru User Guide.

" + "smithy.api#documentation": "

An array of severity values used to search for insights.\n\t\t\tFor more information, see \n\tUnderstanding \n\tinsight severities in the Amazon DevOps Guru User Guide.

" } }, "Status": { @@ -3682,7 +3839,7 @@ } }, "traits": { - "smithy.api#documentation": "

Details about a proactive insight. This object is returned by\n\t\t\tDescribeInsight.

" + "smithy.api#documentation": "

Details about a proactive insight. This object is returned by\n\t\t\t\tDescribeInsight.

" } }, "com.amazonaws.devopsguru#ProactiveOrganizationInsights": { @@ -3947,6 +4104,12 @@ "traits": { "smithy.api#documentation": "

The ID of the Amazon Web Services System Manager OpsItem created for this insight. You must enable\n\t\t\tthe creation of OpstItems insights before they are created for each insight.

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

Describes the reactive insight.

" + } } }, "traits": { @@ -4039,7 +4202,7 @@ "Severity": { "target": "com.amazonaws.devopsguru#InsightSeverity", "traits": { - "smithy.api#documentation": "

An array of severity values used to search for insights. For more information, see \n\tUnderstanding \n\tinsight severities in the Amazon DevOps Guru User Guide.

" + "smithy.api#documentation": "

An array of severity values used to search for insights.\n\t\t\tFor more information, see \n\tUnderstanding \n\tinsight severities in the Amazon DevOps Guru User Guide.

" } }, "Status": { @@ -4059,7 +4222,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information about a reactive insight. This object is returned by\n\t\t\tDescribeInsight.

" + "smithy.api#documentation": "

Information about a reactive insight. This object is returned by\n\t\t\t\tDescribeInsight.

" } }, "com.amazonaws.devopsguru#ReactiveOrganizationInsights": { @@ -4106,12 +4269,21 @@ "traits": { "smithy.api#documentation": "

Anomalies that are related to the problem. Use these Anomalies to learn more about\n\t\t\twhat's happening and to help address the issue.

" } + }, + "Category": { + "target": "com.amazonaws.devopsguru#RecommendationCategory", + "traits": { + "smithy.api#documentation": "

The category type of the recommendation.

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

Recommendation information to help you remediate detected anomalous behavior that\n\t\t\tgenerated an insight.

" } }, + "com.amazonaws.devopsguru#RecommendationCategory": { + "type": "string" + }, "com.amazonaws.devopsguru#RecommendationDescription": { "type": "string" }, @@ -4168,7 +4340,7 @@ "Type": { "target": "com.amazonaws.devopsguru#RecommendationRelatedAnomalyResourceType", "traits": { - "smithy.api#documentation": "

The type of the resource. Resource types take the same form that is \n\t\t\tused by Amazon Web Services CloudFormation resource type identifiers, service-provider::service-name::data-type-name. \n\t\t\tFor example, AWS::RDS::DBCluster. For more information, see \n\t\t\tAmazon Web Services resource and \n\t\t\t\tproperty types reference in the Amazon Web Services CloudFormation User Guide.

" + "smithy.api#documentation": "

The type of the resource. Resource types take the same form that is used by Amazon Web Services CloudFormation\n\t\t\tresource type identifiers, service-provider::service-name::data-type-name.\n\t\t\tFor example, AWS::RDS::DBCluster. For more information, see Amazon Web Services\n\t\t\t\tresource and property types reference in the Amazon Web Services CloudFormation User\n\t\t\t\tGuide.

" } } }, @@ -4388,7 +4560,7 @@ "Tags": { "target": "com.amazonaws.devopsguru#TagCollections", "traits": { - "smithy.api#documentation": "

The Amazon Web Services tags that are used by resources in the resource collection.

\n \t

Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support\n \t\ttagging, so you can assign the same tag to resources from different services to indicate\n \t\tthat the resources are related. For example, you can assign the same tag to an Amazon DynamoDB\n \t\ttable resource that you assign to an Lambda function. For more information about\n \t\tusing tags, see the Tagging\n \t\t\tbest practices whitepaper.

\n \t

Each Amazon Web Services tag has two parts.

\n \t
    \n
  • \n \t\t\t

    A tag key (for example, CostCenter,\n \t\t\t\tEnvironment, Project, or Secret). Tag\n \t\t\t\tkeys are case-sensitive.

    \n \t\t
    • \n
  • \n \t\t\t

    An optional field known as a tag value (for example,\n \t\t\t\t111122223333, Production, or a team\n \t\t\t\tname). Omitting the tag value is the same as using an empty\n \t\t\t\tstring. Like tag keys, tag values are\n \t\t\t\tcase-sensitive.

    \n \t\t
    • \n
\n \t

Together these are known as key-value pairs.

\n \t \n\t\t

The string used for a key in a tag that you use to define your resource coverage must begin with the\n\t\t\tprefix Devops-guru-. The tag key might be\n\t\t\tDevops-guru-deployment-application or\n\t\t\tDevops-guru-rds-application. While keys are case-sensitive, the\n\t\t\tcase of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a\n\t\t\tkey named devops-guru-rds and a key named\n\t\t\tDevOps-Guru-RDS. Possible key/value pairs in your\n\t\t\tapplication might be Devops-Guru-production-application/RDS or\n\t\t\tDevops-Guru-production-application/containers.

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

The Amazon Web Services tags that are used by resources in the resource collection.

\n\t\t

Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support\n \t\ttagging, so you can assign the same tag to resources from different services to indicate\n \t\tthat the resources are related. For example, you can assign the same tag to an Amazon DynamoDB\n \t\ttable resource that you assign to an Lambda function. For more information about\n \t\tusing tags, see the Tagging\n \t\t\tbest practices whitepaper.

\n \t

Each Amazon Web Services tag has two parts.

\n \t
    \n
  • \n \t\t\t

    A tag key (for example, CostCenter,\n \t\t\t\tEnvironment, Project, or Secret). Tag\n \t\t\t\tkeys are case-sensitive.

    \n \t\t
    • \n
  • \n \t\t\t

    An optional field known as a tag value (for example,\n \t\t\t\t111122223333, Production, or a team\n \t\t\t\tname). Omitting the tag value is the same as using an empty\n \t\t\t\tstring. Like tag keys, tag values are\n \t\t\t\tcase-sensitive.

    \n \t\t
    • \n
\n \t

Together these are known as key-value pairs.

\n \t \n\t\t

The string used for a key in a tag that you use to define your resource coverage must begin with the\n\t\t\tprefix Devops-guru-. The tag key might be\n\t\t\tDevops-guru-deployment-application or\n\t\t\tDevops-guru-rds-application. While keys are case-sensitive, the\n\t\t\tcase of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a\n\t\t\tkey named devops-guru-rds and a key named\n\t\t\tDevOps-Guru-RDS. Possible key/value pairs in your\n\t\t\tapplication might be Devops-Guru-production-application/RDS or\n\t\t\tDevops-Guru-production-application/containers.

\n\t " } } }, @@ -4408,7 +4580,7 @@ "Tags": { "target": "com.amazonaws.devopsguru#TagCollectionFilters", "traits": { - "smithy.api#documentation": "

The Amazon Web Services tags used to filter the resources in the resource collection.

\n \t

Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support\n \t\ttagging, so you can assign the same tag to resources from different services to indicate\n \t\tthat the resources are related. For example, you can assign the same tag to an Amazon DynamoDB\n \t\ttable resource that you assign to an Lambda function. For more information about\n \t\tusing tags, see the Tagging\n \t\t\tbest practices whitepaper.

\n \t

Each Amazon Web Services tag has two parts.

\n \t
    \n
  • \n \t\t\t

    A tag key (for example, CostCenter,\n \t\t\t\tEnvironment, Project, or Secret). Tag\n \t\t\t\tkeys are case-sensitive.

    \n \t\t
    • \n
  • \n \t\t\t

    An optional field known as a tag value (for example,\n \t\t\t\t111122223333, Production, or a team\n \t\t\t\tname). Omitting the tag value is the same as using an empty\n \t\t\t\tstring. Like tag keys, tag values are\n \t\t\t\tcase-sensitive.

    \n \t\t
    • \n
\n \t

Together these are known as key-value pairs.

\n \t \n\t\t

The string used for a key in a tag that you use to define your resource coverage must begin with the\n\t\t\tprefix Devops-guru-. The tag key might be\n\t\t\tDevops-guru-deployment-application or\n\t\t\tDevops-guru-rds-application. While keys are case-sensitive, the\n\t\t\tcase of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a\n\t\t\tkey named devops-guru-rds and a key named\n\t\t\tDevOps-Guru-RDS. Possible key/value pairs in your\n\t\t\tapplication might be Devops-Guru-production-application/RDS or\n\t\t\tDevops-Guru-production-application/containers.

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

The Amazon Web Services tags used to filter the resources in the resource collection.

\n\t\t

Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support\n \t\ttagging, so you can assign the same tag to resources from different services to indicate\n \t\tthat the resources are related. For example, you can assign the same tag to an Amazon DynamoDB\n \t\ttable resource that you assign to an Lambda function. For more information about\n \t\tusing tags, see the Tagging\n \t\t\tbest practices whitepaper.

\n \t

Each Amazon Web Services tag has two parts.

\n \t
    \n
  • \n \t\t\t

    A tag key (for example, CostCenter,\n \t\t\t\tEnvironment, Project, or Secret). Tag\n \t\t\t\tkeys are case-sensitive.

    \n \t\t
    • \n
  • \n \t\t\t

    An optional field known as a tag value (for example,\n \t\t\t\t111122223333, Production, or a team\n \t\t\t\tname). Omitting the tag value is the same as using an empty\n \t\t\t\tstring. Like tag keys, tag values are\n \t\t\t\tcase-sensitive.

    \n \t\t
    • \n
\n \t

Together these are known as key-value pairs.

\n \t \n\t\t

The string used for a key in a tag that you use to define your resource coverage must begin with the\n\t\t\tprefix Devops-guru-. The tag key might be\n\t\t\tDevops-guru-deployment-application or\n\t\t\tDevops-guru-rds-application. While keys are case-sensitive, the\n\t\t\tcase of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a\n\t\t\tkey named devops-guru-rds and a key named\n\t\t\tDevOps-Guru-RDS. Possible key/value pairs in your\n\t\t\tapplication might be Devops-Guru-production-application/RDS or\n\t\t\tDevops-Guru-production-application/containers.

\n\t " } } }, @@ -4663,7 +4835,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of insights in your organization. You can specify which insights are\n\t\t\treturned by their start time, one or more statuses (ONGOING,\n\t\t\tCLOSED, and CLOSED), one or more severities\n\t\t\t(LOW, MEDIUM, and HIGH), and type\n\t\t\t(REACTIVE or PROACTIVE).

\n\t\t

Use the Filters parameter to specify status and severity search\n\t\t\tparameters. Use the Type parameter to specify REACTIVE or\n\t\t\tPROACTIVE in your search.

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

Returns a list of insights in your organization. You can specify which insights are\n\t\t\treturned by their start time, one or more statuses (ONGOING,\n\t\t\t\tCLOSED, and CLOSED), one or more severities\n\t\t\t\t(LOW, MEDIUM, and HIGH), and type\n\t\t\t\t(REACTIVE or PROACTIVE).

\n\t\t

Use the Filters parameter to specify status and severity search\n\t\t\tparameters. Use the Type parameter to specify REACTIVE or\n\t\t\t\tPROACTIVE in your search.

", "smithy.api#http": { "method": "POST", "uri": "/organization/insights/search", @@ -4749,7 +4921,7 @@ "Type": { "target": "com.amazonaws.devopsguru#InsightType", "traits": { - "smithy.api#documentation": "

The type of insights you are searching for (REACTIVE or\n\t\t\tPROACTIVE).

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

The type of insights you are searching for (REACTIVE or\n\t\t\t\tPROACTIVE).

", "smithy.api#required": {} } } @@ -5155,13 +5327,13 @@ "TagValues": { "target": "com.amazonaws.devopsguru#TagValues", "traits": { - "smithy.api#documentation": "

The values in an Amazon Web Services tag collection.

\n \t

The tag's value is an optional field used to associate a string with \n\t\t\t\t\tthe tag key (for example, 111122223333, Production, or a team\n \t\t\t\tname). The key and value are the tag's key pair. \n \t\t\t\tOmitting the tag value is the same as using an empty\n \t\t\t\tstring. Like tag keys, tag values are\n \t\t\t\tcase-sensitive. You can specify a maximum of 256 characters for a tag value.

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

The values in an Amazon Web Services tag collection.

\n

The tag's value is an optional field used to associate a string with \n\t\t\t\t\tthe tag key (for example, 111122223333, Production, or a team\n \t\t\t\tname). The key and value are the tag's key pair. \n \t\t\t\tOmitting the tag value is the same as using an empty\n \t\t\t\tstring. Like tag keys, tag values are\n \t\t\t\tcase-sensitive. You can specify a maximum of 256 characters for a tag value.

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

A collection of Amazon Web Services stags.

\n \t

Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support\n \t\ttagging, so you can assign the same tag to resources from different services to indicate\n \t\tthat the resources are related. For example, you can assign the same tag to an Amazon DynamoDB\n \t\ttable resource that you assign to an Lambda function. For more information about\n \t\tusing tags, see the Tagging\n \t\t\tbest practices whitepaper.

\n \t

Each Amazon Web Services tag has two parts.

\n \t
    \n
  • \n \t\t\t

    A tag key (for example, CostCenter,\n \t\t\t\tEnvironment, Project, or Secret). Tag\n \t\t\t\tkeys are case-sensitive.

    \n \t\t
    • \n
  • \n \t\t\t

    An optional field known as a tag value (for example,\n \t\t\t\t111122223333, Production, or a team\n \t\t\t\tname). Omitting the tag value is the same as using an empty\n \t\t\t\tstring. Like tag keys, tag values are\n \t\t\t\tcase-sensitive.

    \n \t\t
    • \n
\n \t

Together these are known as key-value pairs.

\n \t \n\t\t

The string used for a key in a tag that you use to define your resource coverage must begin with the\n\t\t\tprefix Devops-guru-. The tag key might be\n\t\t\tDevops-guru-deployment-application or\n\t\t\tDevops-guru-rds-application. While keys are case-sensitive, the\n\t\t\tcase of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a\n\t\t\tkey named devops-guru-rds and a key named\n\t\t\tDevOps-Guru-RDS. Possible key/value pairs in your\n\t\t\tapplication might be Devops-Guru-production-application/RDS or\n\t\t\tDevops-Guru-production-application/containers.

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

A collection of Amazon Web Services stags.

\n

Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support\n \t\ttagging, so you can assign the same tag to resources from different services to indicate\n \t\tthat the resources are related. For example, you can assign the same tag to an Amazon DynamoDB\n \t\ttable resource that you assign to an Lambda function. For more information about\n \t\tusing tags, see the Tagging\n \t\t\tbest practices whitepaper.

\n \t

Each Amazon Web Services tag has two parts.

\n \t
    \n
  • \n \t\t\t

    A tag key (for example, CostCenter,\n \t\t\t\tEnvironment, Project, or Secret). Tag\n \t\t\t\tkeys are case-sensitive.

    \n \t\t
    • \n
  • \n \t\t\t

    An optional field known as a tag value (for example,\n \t\t\t\t111122223333, Production, or a team\n \t\t\t\tname). Omitting the tag value is the same as using an empty\n \t\t\t\tstring. Like tag keys, tag values are\n \t\t\t\tcase-sensitive.

    \n \t\t
    • \n
\n \t

Together these are known as key-value pairs.

\n \t \n\t\t

The string used for a key in a tag that you use to define your resource coverage must begin with the\n\t\t\tprefix Devops-guru-. The tag key might be\n\t\t\tDevops-guru-deployment-application or\n\t\t\tDevops-guru-rds-application. While keys are case-sensitive, the\n\t\t\tcase of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a\n\t\t\tkey named devops-guru-rds and a key named\n\t\t\tDevOps-Guru-RDS. Possible key/value pairs in your\n\t\t\tapplication might be Devops-Guru-production-application/RDS or\n\t\t\tDevops-Guru-production-application/containers.

\n\t " } }, "com.amazonaws.devopsguru#TagCollectionFilter": { @@ -5177,13 +5349,13 @@ "TagValues": { "target": "com.amazonaws.devopsguru#TagValues", "traits": { - "smithy.api#documentation": "

The values in an Amazon Web Services tag collection.

\n \t

The tag's value is an optional field used to associate a string with \n\t\t\t\t\tthe tag key (for example, 111122223333, Production, or a team\n \t\t\t\tname). The key and value are the tag's key pair. \n \t\t\t\tOmitting the tag value is the same as using an empty\n \t\t\t\tstring. Like tag keys, tag values are\n \t\t\t\tcase-sensitive. You can specify a maximum of 256 characters for a tag value.

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

The values in an Amazon Web Services tag collection.

\n

The tag's value is an optional field used to associate a string with \n\t\t\t\t\tthe tag key (for example, 111122223333, Production, or a team\n \t\t\t\tname). The key and value are the tag's key pair. \n \t\t\t\tOmitting the tag value is the same as using an empty\n \t\t\t\tstring. Like tag keys, tag values are\n \t\t\t\tcase-sensitive. You can specify a maximum of 256 characters for a tag value.

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

A collection of Amazon Web Services tags used to filter insights. This is used to return insights generated from \n only resources that contain the tags in the tag collection.

" + "smithy.api#documentation": "

A collection of Amazon Web Services tags used to filter insights. This is used to return insights\n\t\t\tgenerated from only resources that contain the tags in the tag collection.

" } }, "com.amazonaws.devopsguru#TagCollectionFilters": { @@ -5211,13 +5383,13 @@ "TagValues": { "target": "com.amazonaws.devopsguru#CostEstimationTagValues", "traits": { - "smithy.api#documentation": "

The values in an Amazon Web Services tag collection.

\n \t

The tag's value is an optional field used to associate a string with \n\t\t\t\t\tthe tag key (for example, 111122223333, Production, or a team\n \t\t\t\tname). The key and value are the tag's key pair. \n \t\t\t\tOmitting the tag value is the same as using an empty\n \t\t\t\tstring. Like tag keys, tag values are\n \t\t\t\tcase-sensitive. You can specify a maximum of 256 characters for a tag value.

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

The values in an Amazon Web Services tag collection.

\n

The tag's value is an optional field used to associate a string with \n\t\t\t\t\tthe tag key (for example, 111122223333, Production, or a team\n \t\t\t\tname). The key and value are the tag's key pair. \n \t\t\t\tOmitting the tag value is the same as using an empty\n \t\t\t\tstring. Like tag keys, tag values are\n \t\t\t\tcase-sensitive. You can specify a maximum of 256 characters for a tag value.

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

Information about a collection of Amazon Web Services resources that are identified by an \n \t\tAmazon Web Services tag. This collection of resources is used to create a monthly cost estimate\n \t\tfor DevOps Guru to analyze Amazon Web Services resources. The maximum number of tags you can specify for a\n \t\tcost estimate is one. The estimate created is for the cost to analyze the Amazon Web Services\n \t\tresources defined by the tag. For more information, see Stacks in the\n \t\tAmazon Web Services CloudFormation User Guide.

" + "smithy.api#documentation": "

Information about a collection of Amazon Web Services resources that are identified by an Amazon Web Services tag.\n\t\t\tThis collection of resources is used to create a monthly cost estimate for DevOps Guru to\n\t\t\tanalyze Amazon Web Services resources. The maximum number of tags you can specify for a cost estimate\n\t\t\tis one. The estimate created is for the cost to analyze the Amazon Web Services resources defined by\n\t\t\tthe tag. For more information, see Stacks in the\n\t\t\t\tAmazon Web Services CloudFormation User Guide.

" } }, "com.amazonaws.devopsguru#TagCostEstimationResourceCollectionFilters": { @@ -5238,18 +5410,18 @@ "TagValue": { "target": "com.amazonaws.devopsguru#TagValue", "traits": { - "smithy.api#documentation": "

The value in an Amazon Web Services tag.

\n \t

The tag's value is an optional field used to associate a string with \n\t\t\t\t\tthe tag key (for example, 111122223333, Production, or a team\n \t\t\t\tname). The key and value are the tag's key pair. \n \t\t\t\tOmitting the tag value is the same as using an empty\n \t\t\t\tstring. Like tag keys, tag values are\n \t\t\t\tcase-sensitive. You can specify a maximum of 256 characters for a tag value.

" + "smithy.api#documentation": "

The value in an Amazon Web Services tag.

\n

The tag's value is an optional field used to associate a string with \n\t\t\t\t\tthe tag key (for example, 111122223333, Production, or a team\n \t\t\t\tname). The key and value are the tag's key pair. \n \t\t\t\tOmitting the tag value is the same as using an empty\n \t\t\t\tstring. Like tag keys, tag values are\n \t\t\t\tcase-sensitive. You can specify a maximum of 256 characters for a tag value.

" } }, "Insight": { "target": "com.amazonaws.devopsguru#InsightHealth", "traits": { - "smithy.api#documentation": "

Information about the health of the Amazon Web Services resources in your account that are\n\t\t\tspecified by an Amazon Web Services tag, including the number of open proactive, open reactive\n\t\t\tinsights, and the Mean Time to Recover (MTTR) of closed insights.

" + "smithy.api#documentation": "

Information about the health of the Amazon Web Services resources in your account that are specified\n\t\t\tby an Amazon Web Services tag, including the number of open proactive, open reactive insights, and the\n\t\t\tMean Time to Recover (MTTR) of closed insights.

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

Information about the health of Amazon Web Services resources in your account that are specified by\n \t\tan Amazon Web Services tag key.

" + "smithy.api#documentation": "

Information about the health of Amazon Web Services resources in your account that are specified by\n\t\t\tan Amazon Web Services tag key.

" } }, "com.amazonaws.devopsguru#TagHealths": { @@ -5362,6 +5534,52 @@ "smithy.api#documentation": "

Contains the names of Amazon Web Services CloudFormation stacks used to update a collection of stacks.\n\t\t\tYou can specify up to 500 Amazon Web Services CloudFormation stacks.

" } }, + "com.amazonaws.devopsguru#UpdateEventSourcesConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.devopsguru#UpdateEventSourcesConfigRequest" + }, + "output": { + "target": "com.amazonaws.devopsguru#UpdateEventSourcesConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.devopsguru#AccessDeniedException" + }, + { + "target": "com.amazonaws.devopsguru#InternalServerException" + }, + { + "target": "com.amazonaws.devopsguru#ThrottlingException" + }, + { + "target": "com.amazonaws.devopsguru#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the event source configuration.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/event-sources", + "code": 200 + } + } + }, + "com.amazonaws.devopsguru#UpdateEventSourcesConfigRequest": { + "type": "structure", + "members": { + "EventSources": { + "target": "com.amazonaws.devopsguru#EventSourcesConfig", + "traits": { + "smithy.api#documentation": "

The name of the event source.

" + } + } + } + }, + "com.amazonaws.devopsguru#UpdateEventSourcesConfigResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.devopsguru#UpdateResourceCollection": { "type": "operation", "input": { @@ -5423,7 +5641,7 @@ "Tags": { "target": "com.amazonaws.devopsguru#UpdateTagCollectionFilters", "traits": { - "smithy.api#documentation": "

The updated Amazon Web Services tags used to filter the resources in the resource collection.

\n \t

Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support\n \t\ttagging, so you can assign the same tag to resources from different services to indicate\n \t\tthat the resources are related. For example, you can assign the same tag to an Amazon DynamoDB\n \t\ttable resource that you assign to an Lambda function. For more information about\n \t\tusing tags, see the Tagging\n \t\t\tbest practices whitepaper.

\n \t

Each Amazon Web Services tag has two parts.

\n \t
    \n
  • \n \t\t\t

    A tag key (for example, CostCenter,\n \t\t\t\tEnvironment, Project, or Secret). Tag\n \t\t\t\tkeys are case-sensitive.

    \n \t\t
    • \n
  • \n \t\t\t

    An optional field known as a tag value (for example,\n \t\t\t\t111122223333, Production, or a team\n \t\t\t\tname). Omitting the tag value is the same as using an empty\n \t\t\t\tstring. Like tag keys, tag values are\n \t\t\t\tcase-sensitive.

    \n \t\t
    • \n
\n \t

Together these are known as key-value pairs.

\n \t \n\t\t

The string used for a key in a tag that you use to define your resource coverage must begin with the\n\t\t\tprefix Devops-guru-. The tag key might be\n\t\t\tDevops-guru-deployment-application or\n\t\t\tDevops-guru-rds-application. While keys are case-sensitive, the\n\t\t\tcase of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a\n\t\t\tkey named devops-guru-rds and a key named\n\t\t\tDevOps-Guru-RDS. Possible key/value pairs in your\n\t\t\tapplication might be Devops-Guru-production-application/RDS or\n\t\t\tDevops-Guru-production-application/containers.

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

The updated Amazon Web Services tags used to filter the resources in the resource collection.

\n\t\t

Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support\n \t\ttagging, so you can assign the same tag to resources from different services to indicate\n \t\tthat the resources are related. For example, you can assign the same tag to an Amazon DynamoDB\n \t\ttable resource that you assign to an Lambda function. For more information about\n \t\tusing tags, see the Tagging\n \t\t\tbest practices whitepaper.

\n \t

Each Amazon Web Services tag has two parts.

\n \t
    \n
  • \n \t\t\t

    A tag key (for example, CostCenter,\n \t\t\t\tEnvironment, Project, or Secret). Tag\n \t\t\t\tkeys are case-sensitive.

    \n \t\t
    • \n
  • \n \t\t\t

    An optional field known as a tag value (for example,\n \t\t\t\t111122223333, Production, or a team\n \t\t\t\tname). Omitting the tag value is the same as using an empty\n \t\t\t\tstring. Like tag keys, tag values are\n \t\t\t\tcase-sensitive.

    \n \t\t
    • \n
\n \t

Together these are known as key-value pairs.

\n \t \n\t\t

The string used for a key in a tag that you use to define your resource coverage must begin with the\n\t\t\tprefix Devops-guru-. The tag key might be\n\t\t\tDevops-guru-deployment-application or\n\t\t\tDevops-guru-rds-application. While keys are case-sensitive, the\n\t\t\tcase of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a\n\t\t\tkey named devops-guru-rds and a key named\n\t\t\tDevOps-Guru-RDS. Possible key/value pairs in your\n\t\t\tapplication might be Devops-Guru-production-application/RDS or\n\t\t\tDevops-Guru-production-application/containers.

\n\t " } } }, @@ -5539,13 +5757,13 @@ "TagValues": { "target": "com.amazonaws.devopsguru#UpdateTagValues", "traits": { - "smithy.api#documentation": "

The values in an Amazon Web Services tag collection.

\n \t

The tag's value is an optional field used to associate a string with \n\t\t\t\t\tthe tag key (for example, 111122223333, Production, or a team\n \t\t\t\tname). The key and value are the tag's key pair. \n \t\t\t\tOmitting the tag value is the same as using an empty\n \t\t\t\tstring. Like tag keys, tag values are\n \t\t\t\tcase-sensitive. You can specify a maximum of 256 characters for a tag value.

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

The values in an Amazon Web Services tag collection.

\n

The tag's value is an optional field used to associate a string with \n\t\t\t\t\tthe tag key (for example, 111122223333, Production, or a team\n \t\t\t\tname). The key and value are the tag's key pair. \n \t\t\t\tOmitting the tag value is the same as using an empty\n \t\t\t\tstring. Like tag keys, tag values are\n \t\t\t\tcase-sensitive. You can specify a maximum of 256 characters for a tag value.

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

A new collection of Amazon Web Services resources that are defined by an Amazon Web Services tag or tag \n key/value pair.

" + "smithy.api#documentation": "

A new collection of Amazon Web Services resources that are defined by an Amazon Web Services tag or tag\n\t\t\tkey/value pair.

" } }, "com.amazonaws.devopsguru#UpdateTagCollectionFilters": { diff --git a/aws/sdk/aws-models/ec2.json b/aws/sdk/aws-models/ec2.json index 7bcdea00a4..5b4de08cbe 100644 --- a/aws/sdk/aws-models/ec2.json +++ b/aws/sdk/aws-models/ec2.json @@ -10901,7 +10901,7 @@ "Type": { "target": "com.amazonaws.ec2#FleetType", "traits": { - "smithy.api#documentation": "

The fleet type. The default value is maintain.

\n
    \n
  • \n

    \n maintain - The EC2 Fleet places an asynchronous request for your desired\n capacity, and continues to maintain your desired Spot capacity by replenishing\n interrupted Spot Instances.

    \n
    • \n
  • \n

    \n request - The EC2 Fleet places an asynchronous one-time request for your\n desired capacity, but does submit Spot requests in alternative capacity pools if Spot\n capacity is unavailable, and does not maintain Spot capacity if Spot Instances are\n interrupted.

    \n
    • \n
  • \n

    \n instant - The EC2 Fleet places a synchronous one-time request for your\n desired capacity, and returns errors for any instances that could not be\n launched.

    \n
    • \n
\n

For more information, see EC2 Fleet\n request types in the Amazon EC2 User Guide.

" + "smithy.api#documentation": "

The fleet type. The default value is maintain.

\n
    \n
  • \n

    \n maintain - The EC2 Fleet places an asynchronous request for your desired\n capacity, and continues to maintain your desired Spot capacity by replenishing\n interrupted Spot Instances.

    \n
    • \n
  • \n

    \n request - The EC2 Fleet places an asynchronous one-time request for your\n desired capacity, but does submit Spot requests in alternative capacity pools if Spot\n capacity is unavailable, and does not maintain Spot capacity if Spot Instances are\n interrupted.

    \n
    • \n
  • \n

    \n instant - The EC2 Fleet places a synchronous one-time request for your\n desired capacity, and returns errors for any instances that could not be\n launched.

    \n
    • \n
\n

For more information, see EC2 Fleet\n request types in the Amazon EC2 User Guide.

" } }, "ValidFrom": { @@ -11504,7 +11504,8 @@ "AddressFamily": { "target": "com.amazonaws.ec2#AddressFamily", "traits": { - "smithy.api#documentation": "

The IP protocol assigned to this IPAM pool. You must choose either IPv4 or IPv6 protocol for a pool.

" + "smithy.api#documentation": "

The IP protocol assigned to this IPAM pool. You must choose either IPv4 or IPv6 protocol for a pool.

", + "smithy.api#required": {} } }, "AutoImport": { @@ -16425,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
    \n
  • \n

    Deallocates any CIDRs allocated to VPC resources (such as VPCs) in pools in private scopes.

    \n \n

    No VPC resources are deleted as a result of enabling this option. The CIDR associated with the resource will no longer be allocated from an IPAM pool, but the CIDR itself will remain unchanged.

    \n     \n
    • \n
  • \n

    Deprovisions all IPv4 CIDRs provisioned to IPAM pools in private scopes.

    \n
    • \n
  • \n

    Deletes all IPAM pools in private scopes.

    \n
    • \n
  • \n

    Deletes all non-default private scopes in the IPAM.

    \n
    • \n
  • \n

    Deletes the default public and private scopes and the IPAM.

    \n
    • \n
" + } } } }, @@ -40723,8 +40730,17 @@ "target": "com.amazonaws.ec2#AttributeValue", "traits": { "aws.protocols#ec2QueryName": "BootMode", + "smithy.api#documentation": "

The boot mode.

", "smithy.api#xmlName": "bootMode" } + }, + "LastLaunchedTime": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "LastLaunchedTime", + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the AMI was last used to launch an EC2 instance. When the AMI is used,\n there is a 24-hour delay before that usage is reported.

\n \n

\n lastLaunchedTime data is available starting April 2017.

\n ", + "smithy.api#xmlName": "lastLaunchedTime" + } } }, "traits": { @@ -40766,6 +40782,10 @@ { "value": "bootMode", "name": "bootMode" + }, + { + "value": "lastLaunchedTime", + "name": "lastLaunchedTime" } ] } @@ -44405,7 +44425,7 @@ "target": "com.amazonaws.ec2#Integer", "traits": { "aws.protocols#ec2QueryName": "SpotMaxPricePercentageOverLowestPrice", - "smithy.api#documentation": "

The price protection threshold for Spot Instances. This is the maximum you’ll pay for a Spot Instance,\n expressed as a percentage above the cheapest M, C, or R instance type with your specified\n attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance\n types priced above your threshold.

\n

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

\n

To turn off price protection, specify a high value, such as 999999.

\n

This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.

\n

Default: 100\n

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

The price protection threshold for Spot Instances. This is the maximum you’ll pay for a Spot Instance,\n expressed as a percentage above the cheapest M, C, or R instance type with your specified\n attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance\n types priced above your threshold.

\n

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

\n

To turn off price protection, specify a high value, such as 999999.

\n

This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.

\n \n

If you set TargetCapacityUnitType to vcpu or\n memory-mib, the price protection threshold is applied based on the\n per-vCPU or per-memory price instead of the per-instance price.

\n \n

Default: 100\n

", "smithy.api#xmlName": "spotMaxPricePercentageOverLowestPrice" } }, @@ -44413,7 +44433,7 @@ "target": "com.amazonaws.ec2#Integer", "traits": { "aws.protocols#ec2QueryName": "OnDemandMaxPricePercentageOverLowestPrice", - "smithy.api#documentation": "

The price protection threshold for On-Demand Instances. This is the maximum you’ll pay for an On-Demand Instance,\n expressed as a percentage above the cheapest M, C, or R instance type with your specified\n attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance\n types priced above your threshold.

\n

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

\n

To turn off price protection, specify a high value, such as 999999.

\n

This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.

\n

Default: 20\n

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

The price protection threshold for On-Demand Instances. This is the maximum you’ll pay for an On-Demand Instance,\n expressed as a percentage above the cheapest M, C, or R instance type with your specified\n attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance\n types priced above your threshold.

\n

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

\n

To turn off price protection, specify a high value, such as 999999.

\n

This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.

\n \n

If you set TargetCapacityUnitType to vcpu or\n memory-mib, the price protection threshold is applied based on the\n per-vCPU or per-memory price instead of the per-instance price.

\n \n

Default: 20\n

", "smithy.api#xmlName": "onDemandMaxPricePercentageOverLowestPrice" } }, @@ -44573,13 +44593,13 @@ "SpotMaxPricePercentageOverLowestPrice": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The price protection threshold for Spot Instance. This is the maximum you’ll pay for an Spot Instance,\n expressed as a percentage above the cheapest M, C, or R instance type with your specified\n attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance\n types priced above your threshold.

\n

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

\n

To turn off price protection, specify a high value, such as 999999.

\n

This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.

\n

Default: 100\n

" + "smithy.api#documentation": "

The price protection threshold for Spot Instance. This is the maximum you’ll pay for an Spot Instance,\n expressed as a percentage above the cheapest M, C, or R instance type with your specified\n attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance\n types priced above your threshold.

\n

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

\n

To turn off price protection, specify a high value, such as 999999.

\n

This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.

\n \n

If you set TargetCapacityUnitType to vcpu or\n memory-mib, the price protection threshold is applied based on the\n per-vCPU or per-memory price instead of the per-instance price.

\n \n

Default: 100\n

" } }, "OnDemandMaxPricePercentageOverLowestPrice": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The price protection threshold for On-Demand Instances. This is the maximum you’ll pay for an On-Demand Instance,\n expressed as a percentage above the cheapest M, C, or R instance type with your specified\n attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance\n types priced above your threshold.

\n

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

\n

To turn off price protection, specify a high value, such as 999999.

\n

This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.

\n

Default: 20\n

" + "smithy.api#documentation": "

The price protection threshold for On-Demand Instances. This is the maximum you’ll pay for an On-Demand Instance,\n expressed as a percentage above the cheapest M, C, or R instance type with your specified\n attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance\n types priced above your threshold.

\n

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

\n

To turn off price protection, specify a high value, such as 999999.

\n

This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.

\n \n

If you set TargetCapacityUnitType to vcpu or\n memory-mib, the price protection threshold is applied based on the\n per-vCPU or per-memory price instead of the per-instance price.

\n \n

Default: 20\n

" } }, "BareMetal": { @@ -48819,7 +48839,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": { @@ -56760,7 +56780,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": { @@ -60960,7 +60980,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": { @@ -61015,7 +61035,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": { @@ -62540,7 +62560,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": {} } } } @@ -65406,6 +65427,10 @@ "value": "subnet", "name": "subnet" }, + { + "value": "subnet-cidr-reservation", + "name": "subnet_cidr_reservation" + }, { "value": "traffic-mirror-filter", "name": "traffic_mirror_filter" diff --git a/aws/sdk/aws-models/ecr.json b/aws/sdk/aws-models/ecr.json index b5860b726f..8f99c9a69d 100644 --- a/aws/sdk/aws-models/ecr.json +++ b/aws/sdk/aws-models/ecr.json @@ -353,7 +353,7 @@ } ], "traits": { - "smithy.api#documentation": "

Checks the availability of one or more image layers in a repository.

\n

When an image is pushed to a repository, each image layer is checked to verify if it\n has been uploaded before. If it has been uploaded, then the image layer is\n skipped.

\n \n

This operation is used by the Amazon ECR proxy and is not generally used by\n customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

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

Checks the availability of one or more image layers in a repository.

\n

When an image is pushed to a repository, each image layer is checked to verify if it\n has been uploaded before. If it has been uploaded, then the image layer is\n skipped.

\n \n

This operation is used by the Amazon ECR proxy and is not generally used by\n customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

\n " } }, "com.amazonaws.ecr#BatchCheckLayerAvailabilityRequest": { @@ -651,7 +651,7 @@ } ], "traits": { - "smithy.api#documentation": "

Informs Amazon ECR that the image layer upload has completed for a specified registry,\n repository name, and upload ID. You can optionally provide a sha256 digest\n of the image layer for data validation purposes.

\n

When an image is pushed, the CompleteLayerUpload API is called once per each new image\n layer to verify that the upload has completed.

\n \n

This operation is used by the Amazon ECR proxy and is not generally used by\n customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

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

Informs Amazon ECR that the image layer upload has completed for a specified registry,\n repository name, and upload ID. You can optionally provide a sha256 digest\n of the image layer for data validation purposes.

\n

When an image is pushed, the CompleteLayerUpload API is called once per each new image\n layer to verify that the upload has completed.

\n \n

This operation is used by the Amazon ECR proxy and is not generally used by\n customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

\n " } }, "com.amazonaws.ecr#CompleteLayerUploadRequest": { @@ -2143,7 +2143,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer. You can\n only get URLs for image layers that are referenced in an image.

\n

When an image is pulled, the GetDownloadUrlForLayer API is called once per image layer\n that is not already cached.

\n \n

This operation is used by the Amazon ECR proxy and is not generally used by\n customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

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

Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer. You can\n only get URLs for image layers that are referenced in an image.

\n

When an image is pulled, the GetDownloadUrlForLayer API is called once per image layer\n that is not already cached.

\n \n

This operation is used by the Amazon ECR proxy and is not generally used by\n customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

\n " } }, "com.amazonaws.ecr#GetDownloadUrlForLayerRequest": { @@ -2703,6 +2703,12 @@ "traits": { "smithy.api#documentation": "

The artifact media type of the image.

" } + }, + "lastRecordedPullTime": { + "target": "com.amazonaws.ecr#RecordedPullTimestamp", + "traits": { + "smithy.api#documentation": "

The date and time, expressed in standard JavaScript date format, when Amazon ECR recorded\n the last image pull.

\n \n

Amazon ECR refreshes the last image pull timestamp at least once every 24 hours. For\n example, if you pull an image once a day then the lastRecordedPullTime\n timestamp will indicate the exact time that the image was last pulled. However, if\n you pull an image once an hour, because Amazon ECR refreshes the\n lastRecordedPullTime timestamp at least once every 24 hours, the\n result may not be the exact time that the image was last pulled.

\n " + } } }, "traits": { @@ -3116,7 +3122,7 @@ } ], "traits": { - "smithy.api#documentation": "

Notifies Amazon ECR that you intend to upload an image layer.

\n

When an image is pushed, the InitiateLayerUpload API is called once per image layer\n that has not already been uploaded. Whether or not an image layer has been uploaded is\n determined by the BatchCheckLayerAvailability API action.

\n \n

This operation is used by the Amazon ECR proxy and is not generally used by\n customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

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

Notifies Amazon ECR that you intend to upload an image layer.

\n

When an image is pushed, the InitiateLayerUpload API is called once per image layer\n that has not already been uploaded. Whether or not an image layer has been uploaded is\n determined by the BatchCheckLayerAvailability API action.

\n \n

This operation is used by the Amazon ECR proxy and is not generally used by\n customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

\n " } }, "com.amazonaws.ecr#InitiateLayerUploadRequest": { @@ -4116,7 +4122,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the image scanning configuration for the specified repository.

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

The PutImageScanningConfiguration API is being deprecated, in favor\n of specifying the image scanning configuration at the registry level. For more\n information, see PutRegistryScanningConfiguration.

\n \n

Updates the image scanning configuration for the specified repository.

" } }, "com.amazonaws.ecr#PutImageScanningConfigurationRequest": { @@ -4390,7 +4396,7 @@ "scanType": { "target": "com.amazonaws.ecr#ScanType", "traits": { - "smithy.api#documentation": "

The scanning type to set for the registry.

\n

By default, the BASIC scan type is used. When basic scanning is set, you\n may specify filters to determine which individual repositories, or all repositories, are\n scanned when new images are pushed. Alternatively, you can do manual scans of images\n with basic scanning.

\n

When the ENHANCED scan type is set, Amazon Inspector provides automated, continuous\n scanning of all repositories in your registry.

" + "smithy.api#documentation": "

The scanning type to set for the registry.

\n

When a registry scanning configuration is not defined, by default the\n BASIC scan type is used. When basic scanning is used, you may specify\n filters to determine which individual repositories, or all repositories, are scanned\n when new images are pushed to those repositories. Alternatively, you can do manual scans\n of images with basic scanning.

\n

When the ENHANCED scan type is set, Amazon Inspector provides automated\n vulnerability scanning. You may choose between continuous scanning or scan on push and\n you may specify filters to determine which individual repositories, or all repositories,\n are scanned.

" } }, "rules": { @@ -4484,6 +4490,9 @@ "com.amazonaws.ecr#RecommendationText": { "type": "string" }, + "com.amazonaws.ecr#RecordedPullTimestamp": { + "type": "timestamp" + }, "com.amazonaws.ecr#ReferenceUrlsList": { "type": "list", "member": { @@ -4565,7 +4574,7 @@ "scanFrequency": { "target": "com.amazonaws.ecr#ScanFrequency", "traits": { - "smithy.api#documentation": "

The frequency that scans are performed at for a private registry.

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

The frequency that scans are performed at for a private registry. When the\n ENHANCED scan type is specified, the supported scan frequencies are\n CONTINUOUS_SCAN and SCAN_ON_PUSH. When the\n BASIC scan type is specified, the SCAN_ON_PUSH and\n MANUAL scan frequencies are supported.

", "smithy.api#required": {} } }, @@ -5546,12 +5555,12 @@ "Value": { "target": "com.amazonaws.ecr#TagValue", "traits": { - "smithy.api#documentation": "

The optional part of a key-value pair that make up a tag. A value acts as\n a descriptor within a tag category (key).

" + "smithy.api#documentation": "

A value acts as a descriptor within a tag category (key).

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

The metadata that you apply to a resource to help you categorize and organize them.\n Each tag consists of a key and an optional value, both of which you define.\n Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.

" + "smithy.api#documentation": "

The metadata to apply to a resource to help you categorize and organize them. Each tag\n consists of a key and a value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.

" } }, "com.amazonaws.ecr#TagKey": { @@ -5784,7 +5793,7 @@ } ], "traits": { - "smithy.api#documentation": "

Uploads an image layer part to Amazon ECR.

\n

When an image is pushed, each new image layer is uploaded in parts. The maximum size\n of each image layer part can be 20971520 bytes (or about 20MB). The UploadLayerPart API\n is called once per each new image layer part.

\n \n

This operation is used by the Amazon ECR proxy and is not generally used by\n customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

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

Uploads an image layer part to Amazon ECR.

\n

When an image is pushed, each new image layer is uploaded in parts. The maximum size\n of each image layer part can be 20971520 bytes (or about 20MB). The UploadLayerPart API\n is called once per each new image layer part.

\n \n

This operation is used by the Amazon ECR proxy and is not generally used by\n customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

\n " } }, "com.amazonaws.ecr#UploadLayerPartRequest": { diff --git a/aws/sdk/aws-models/ecs.json b/aws/sdk/aws-models/ecs.json index 612e0d730f..988d58f2d0 100644 --- a/aws/sdk/aws-models/ecs.json +++ b/aws/sdk/aws-models/ecs.json @@ -369,7 +369,7 @@ } }, "traits": { - "smithy.api#documentation": "

An attribute is a name-value pair that's associated with an Amazon ECS object. Attributes\n\t\t\tenable you to extend the Amazon ECS data model by adding custom metadata to your resources.\n\t\t\tFor more information, see Attributes in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

An attribute is a name-value pair that's associated with an Amazon ECS object. Use attributes\n\t\t\tto extend the Amazon ECS data model by adding custom metadata to your resources.\n\t\t\tFor more information, see Attributes in the Amazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#AttributeLimitExceededException": { @@ -898,7 +898,7 @@ } }, "traits": { - "smithy.api#documentation": "

The settings to use when creating a cluster. This parameter is used to enable CloudWatch\n\t\t\tContainer Insights for a cluster.

" + "smithy.api#documentation": "

The settings to use when creating a cluster. This parameter is used to turn on CloudWatch\n\t\t\tContainer Insights for a cluster.

" } }, "com.amazonaws.ecs#ClusterSettingName": { @@ -1205,19 +1205,19 @@ "dependsOn": { "target": "com.amazonaws.ecs#ContainerDependencies", "traits": { - "smithy.api#documentation": "

The dependencies defined for container startup and shutdown. A container can contain\n\t\t\tmultiple dependencies. When a dependency is defined for container startup, for container\n\t\t\tshutdown it is reversed.

\n\t\t

For tasks using the EC2 launch type, the container instances require at\n\t\t\tleast version 1.26.0 of the container agent to enable container dependencies. However,\n\t\t\twe recommend using the latest container agent version. For information about checking\n\t\t\tyour agent version and updating to the latest version, see Updating the Amazon ECS\n\t\t\t\tContainer Agent in the Amazon Elastic Container Service Developer Guide. If you're using\n\t\t\tan Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the\n\t\t\t\tecs-init package. If your container instances are launched from version\n\t\t\t\t20190301 or later, then they contain the required versions of the\n\t\t\tcontainer agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

\n\t\t

For tasks using the Fargate launch type, the task or service requires\n\t\t\tthe following platforms:

\n\t\t
    \n
  • \n\t\t\t\t

    Linux platform version 1.3.0 or later.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    Windows platform version 1.0.0 or later.

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

The dependencies defined for container startup and shutdown. A container can contain\n\t\t\tmultiple dependencies. When a dependency is defined for container startup, for container\n\t\t\tshutdown it is reversed.

\n\t\t

For tasks using the EC2 launch type, the container instances require at\n\t\t\tleast version 1.26.0 of the container agent to turn on container dependencies. However,\n\t\t\twe recommend using the latest container agent version. For information about checking\n\t\t\tyour agent version and updating to the latest version, see Updating the Amazon ECS\n\t\t\t\tContainer Agent in the Amazon Elastic Container Service Developer Guide. If you're using\n\t\t\tan Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the\n\t\t\t\tecs-init package. If your container instances are launched from version\n\t\t\t\t20190301 or later, then they contain the required versions of the\n\t\t\tcontainer agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

\n\t\t

For tasks using the Fargate launch type, the task or service requires\n\t\t\tthe following platforms:

\n\t\t
    \n
  • \n\t\t\t\t

    Linux platform version 1.3.0 or later.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    Windows platform version 1.0.0 or later.

    \n\t\t\t
    • \n
" } }, "startTimeout": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

Time duration (in seconds) to wait before giving up on resolving dependencies for a\n\t\t\tcontainer. For example, you specify two containers in a task definition with containerA\n\t\t\thaving a dependency on containerB reaching a COMPLETE,\n\t\t\tSUCCESS, or HEALTHY status. If a startTimeout\n\t\t\tvalue is specified for containerB and it doesn't reach the desired status within that\n\t\t\ttime then containerA gives up and not start. This results in the task transitioning to a\n\t\t\t\tSTOPPED state.

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

When the ECS_CONTAINER_START_TIMEOUT container agent configuration\n\t\t\t\tvariable is used, it's enforced independently from this start timeout value.

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

For tasks using the Fargate launch type, the task or service requires\n\t\t\tthe following platforms:

\n\t\t
    \n
  • \n\t\t\t\t

    Linux platform version 1.3.0 or later.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    Windows platform version 1.0.0 or later.

    \n\t\t\t
    • \n
\n\t\t

For tasks using the EC2 launch type, your container instances require at\n\t\t\tleast version 1.26.0 of the container agent to enable a container start\n\t\t\ttimeout value. However, we recommend using the latest container agent version. For\n\t\t\tinformation about checking your agent version and updating to the latest version, see\n\t\t\t\tUpdating the Amazon ECS\n\t\t\t\tContainer Agent in the Amazon Elastic Container Service Developer Guide. If you're using\n\t\t\tan Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the\n\t\t\t\tecs-init package. If your container instances are launched from version\n\t\t\t\t20190301 or later, then they contain the required versions of the\n\t\t\tcontainer agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

Time duration (in seconds) to wait before giving up on resolving dependencies for a\n\t\t\tcontainer. For example, you specify two containers in a task definition with containerA\n\t\t\thaving a dependency on containerB reaching a COMPLETE,\n\t\t\tSUCCESS, or HEALTHY status. If a startTimeout\n\t\t\tvalue is specified for containerB and it doesn't reach the desired status within that\n\t\t\ttime then containerA gives up and not start. This results in the task transitioning to a\n\t\t\t\tSTOPPED state.

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

When the ECS_CONTAINER_START_TIMEOUT container agent configuration\n\t\t\t\tvariable is used, it's enforced independently from this start timeout value.

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

For tasks using the Fargate launch type, the task or service requires\n\t\t\tthe following platforms:

\n\t\t
    \n
  • \n\t\t\t\t

    Linux platform version 1.3.0 or later.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    Windows platform version 1.0.0 or later.

    \n\t\t\t
    • \n
\n\t\t

For tasks using the EC2 launch type, your container instances require at\n\t\t\tleast version 1.26.0 of the container agent to use a container start\n\t\t\ttimeout value. However, we recommend using the latest container agent version. For\n\t\t\tinformation about checking your agent version and updating to the latest version, see\n\t\t\t\tUpdating the Amazon ECS\n\t\t\t\tContainer Agent in the Amazon Elastic Container Service Developer Guide. If you're using\n\t\t\tan Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the\n\t\t\t\tecs-init package. If your container instances are launched from version\n\t\t\t\t20190301 or later, then they contain the required versions of the\n\t\t\tcontainer agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

" } }, "stopTimeout": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

Time duration (in seconds) to wait before the container is forcefully killed if it\n\t\t\tdoesn't exit normally on its own.

\n\t\t

For tasks using the Fargate launch type, the task or service requires\n\t\t\tthe following platforms:

\n\t\t
    \n
  • \n\t\t\t\t

    Linux platform version 1.3.0 or later.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    Windows platform version 1.0.0 or later.

    \n\t\t\t
    • \n
\n\t\t

The max stop timeout value is 120 seconds and if the parameter is not specified, the\n\t\t\tdefault value of 30 seconds is used.

\n\t\t

For tasks that use the EC2 launch type, if the stopTimeout\n\t\t\tparameter isn't specified, the value set for the Amazon ECS container agent configuration\n\t\t\tvariable ECS_CONTAINER_STOP_TIMEOUT is used. If neither the\n\t\t\t\tstopTimeout parameter or the ECS_CONTAINER_STOP_TIMEOUT\n\t\t\tagent configuration variable are set, then the default values of 30 seconds for Linux\n\t\t\tcontainers and 30 seconds on Windows containers are used. Your container instances\n\t\t\trequire at least version 1.26.0 of the container agent to enable a container stop\n\t\t\ttimeout value. However, we recommend using the latest container agent version. For\n\t\t\tinformation about checking your agent version and updating to the latest version, see\n\t\t\t\tUpdating the Amazon ECS\n\t\t\t\tContainer Agent in the Amazon Elastic Container Service Developer Guide. If you're using\n\t\t\tan Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the\n\t\t\t\tecs-init package. If your container instances are launched from version\n\t\t\t\t20190301 or later, then they contain the required versions of the\n\t\t\tcontainer agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

Time duration (in seconds) to wait before the container is forcefully killed if it\n\t\t\tdoesn't exit normally on its own.

\n\t\t

For tasks using the Fargate launch type, the task or service requires\n\t\t\tthe following platforms:

\n\t\t
    \n
  • \n\t\t\t\t

    Linux platform version 1.3.0 or later.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    Windows platform version 1.0.0 or later.

    \n\t\t\t
    • \n
\n\t\t

The max stop timeout value is 120 seconds and if the parameter is not specified, the\n\t\t\tdefault value of 30 seconds is used.

\n\t\t

For tasks that use the EC2 launch type, if the stopTimeout\n\t\t\tparameter isn't specified, the value set for the Amazon ECS container agent configuration\n\t\t\tvariable ECS_CONTAINER_STOP_TIMEOUT is used. If neither the\n\t\t\t\tstopTimeout parameter or the ECS_CONTAINER_STOP_TIMEOUT\n\t\t\tagent configuration variable are set, then the default values of 30 seconds for Linux\n\t\t\tcontainers and 30 seconds on Windows containers are used. Your container instances\n\t\t\trequire at least version 1.26.0 of the container agent to use a container stop\n\t\t\ttimeout value. However, we recommend using the latest container agent version. For\n\t\t\tinformation about checking your agent version and updating to the latest version, see\n\t\t\t\tUpdating the Amazon ECS\n\t\t\t\tContainer Agent in the Amazon Elastic Container Service Developer Guide. If you're using\n\t\t\tan Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the\n\t\t\t\tecs-init package. If your container instances are launched from version\n\t\t\t\t20190301 or later, then they contain the required versions of the\n\t\t\tcontainer agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

" } }, "hostname": { @@ -1370,7 +1370,7 @@ } }, "traits": { - "smithy.api#documentation": "

The dependencies defined for container startup and shutdown. A container can contain\n\t\t\tmultiple dependencies. When a dependency is defined for container startup, for container\n\t\t\tshutdown it is reversed.

\n\t\t

Your Amazon ECS container instances require at least version 1.26.0 of the container agent\n\t\t\tto enable container dependencies. However, we recommend using the latest container agent\n\t\t\tversion. For information about checking your agent version and updating to the latest\n\t\t\tversion, see Updating the Amazon ECS\n\t\t\t\tContainer Agent in the Amazon Elastic Container Service Developer Guide. If you're using\n\t\t\tan Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the\n\t\t\t\tecs-init package. If your container instances are launched from version\n\t\t\t\t20190301 or later, then they contain the required versions of the\n\t\t\tcontainer agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

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

For tasks that use the Fargate launch type, the task or service\n\t\t\t\trequires the following platforms:

\n\t\t\t
    \n
  • \n\t\t\t\t\t

    Linux platform version 1.3.0 or later.

    \n\t\t\t\t
    • \n
  • \n\t\t\t\t\t

    Windows platform version 1.0.0 or later.

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

The dependencies defined for container startup and shutdown. A container can contain\n\t\t\tmultiple dependencies. When a dependency is defined for container startup, for container\n\t\t\tshutdown it is reversed.

\n\t\t

Your Amazon ECS container instances require at least version 1.26.0 of the container agent\n\t\t\tto use container dependencies. However, we recommend using the latest container agent\n\t\t\tversion. For information about checking your agent version and updating to the latest\n\t\t\tversion, see Updating the Amazon ECS\n\t\t\t\tContainer Agent in the Amazon Elastic Container Service Developer Guide. If you're using\n\t\t\tan Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the\n\t\t\t\tecs-init package. If your container instances are launched from version\n\t\t\t\t20190301 or later, then they contain the required versions of the\n\t\t\tcontainer agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

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

For tasks that use the Fargate launch type, the task or service\n\t\t\t\trequires the following platforms:

\n\t\t\t
    \n
  • \n\t\t\t\t\t

    Linux platform version 1.3.0 or later.

    \n\t\t\t\t
    • \n
  • \n\t\t\t\t\t

    Windows platform version 1.0.0 or later.

    \n\t\t\t\t
    • \n
\n\t\t " } }, "com.amazonaws.ecs#ContainerInstance": { @@ -1793,13 +1793,13 @@ "settings": { "target": "com.amazonaws.ecs#ClusterSettings", "traits": { - "smithy.api#documentation": "

The setting to use when creating a cluster. This parameter is used to enable CloudWatch\n\t\t\tContainer Insights for a cluster. If this value is specified, it overrides the\n\t\t\t\tcontainerInsights value set with PutAccountSetting or\n\t\t\t\tPutAccountSettingDefault.

" + "smithy.api#documentation": "

The setting to use when creating a cluster. This parameter is used to turn on CloudWatch\n\t\t\tContainer Insights for a cluster. If this value is specified, it overrides the\n\t\t\t\tcontainerInsights value set with PutAccountSetting or\n\t\t\t\tPutAccountSettingDefault.

" } }, "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": { @@ -1862,7 +1862,7 @@ } ], "traits": { - "smithy.api#documentation": "

Runs and maintains your desired number of tasks from a specified task definition. If\n\t\t\tthe number of tasks running in a service drops below the desiredCount,\n\t\t\tAmazon ECS runs another copy of the task in the specified cluster. To update an existing\n\t\t\tservice, see the UpdateService action.

\n\t\t

In addition to maintaining the desired count of tasks in your service, you can\n\t\t\toptionally run your service behind one or more load balancers. The load balancers\n\t\t\tdistribute traffic across the tasks that are associated with the service. For more\n\t\t\tinformation, see Service Load Balancing in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t

Tasks for services that don't use a load balancer are considered healthy if they're in\n\t\t\tthe RUNNING state. Tasks for services that use a load balancer are\n\t\t\tconsidered healthy if they're in the RUNNING state and the container\n\t\t\tinstance that they're hosted on is reported as healthy by the load balancer.

\n\t\t

There are two service scheduler strategies available:

\n\t\t
    \n
  • \n\t\t\t\t

    \n REPLICA - The replica scheduling strategy places and\n\t\t\t\t\tmaintains your desired number of tasks across your cluster. By default, the\n\t\t\t\t\tservice scheduler spreads tasks across Availability Zones. You can use task\n\t\t\t\t\tplacement strategies and constraints to customize task placement decisions. For\n\t\t\t\t\tmore information, see Service Scheduler Concepts in the\n\t\t\t\t\t\tAmazon Elastic Container Service Developer Guide.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n DAEMON - The daemon scheduling strategy deploys exactly one\n\t\t\t\t\ttask on each active container instance that meets all of the task placement\n\t\t\t\t\tconstraints that you specify in your cluster. The service scheduler also\n\t\t\t\t\tevaluates the task placement constraints for running tasks. It also stops tasks\n\t\t\t\t\tthat don't meet the placement constraints. When using this strategy, you don't\n\t\t\t\t\tneed to specify a desired number of tasks, a task placement strategy, or use\n\t\t\t\t\tService Auto Scaling policies. For more information, see Service Scheduler Concepts in the\n\t\t\t\t\t\tAmazon Elastic Container Service Developer Guide.

    \n\t\t\t
    • \n
\n\t\t

You can optionally specify a deployment configuration for your service. The deployment\n\t\t\tis initiated by changing properties. For example, the deployment might be initiated by\n\t\t\tthe task definition or by your desired count of a service. This is done with an UpdateService operation. The default value for a replica service for\n\t\t\t\tminimumHealthyPercent is 100%. The default value for a daemon service\n\t\t\tfor minimumHealthyPercent is 0%.

\n\t\t

If a service uses the ECS deployment controller, the minimum healthy\n\t\t\tpercent represents a lower limit on the number of tasks in a service that must remain in\n\t\t\tthe RUNNING state during a deployment. Specifically, it represents it as a\n\t\t\tpercentage of your desired number of tasks (rounded up to the nearest integer). This\n\t\t\thappens when any of your container instances are in the DRAINING state if\n\t\t\tthe service contains tasks using the EC2 launch type. Using this\n\t\t\tparameter, you can deploy without using additional cluster capacity. For example, if you\n\t\t\tset your service to have desired number of four tasks and a minimum healthy percent of\n\t\t\t50%, the scheduler might stop two existing tasks to free up cluster capacity before\n\t\t\tstarting two new tasks. If they're in the RUNNING state, tasks for services\n\t\t\tthat don't use a load balancer are considered healthy . If they're in the\n\t\t\t\tRUNNING state and reported as healthy by the load balancer, tasks for\n\t\t\tservices that do use a load balancer are considered healthy . The\n\t\t\tdefault value for minimum healthy percent is 100%.

\n\t\t

If a service uses the ECS deployment controller, the maximum percent parameter represents an upper limit on the\n\t\t\tnumber of tasks in a service that are allowed in the RUNNING or\n\t\t\t\tPENDING state during a deployment. Specifically, it represents it as a\n\t\t\tpercentage of the desired number of tasks (rounded down to the nearest integer). This\n\t\t\thappens when any of your container instances are in the DRAINING state if\n\t\t\tthe service contains tasks using the EC2 launch type. Using this\n\t\t\tparameter, you can define the deployment batch size. For example, if your service has a\n\t\t\tdesired number of four tasks and a maximum percent value of 200%, the scheduler may\n\t\t\tstart four new tasks before stopping the four older tasks (provided that the cluster\n\t\t\tresources required to do this are available). The default value for maximum percent is\n\t\t\t200%.

\n\t\t

If a service uses either the CODE_DEPLOY or EXTERNAL\n\t\t\tdeployment controller types and tasks that use the EC2 launch type, the\n\t\t\t\tminimum healthy percent and maximum percent values are used only to define the lower and upper limit\n\t\t\ton the number of the tasks in the service that remain in the RUNNING state.\n\t\t\tThis is while the container instances are in the DRAINING state. If the\n\t\t\ttasks in the service use the Fargate launch type, the minimum healthy\n\t\t\tpercent and maximum percent values aren't used. This is the case even if they're\n\t\t\tcurrently visible when describing your service.

\n\t\t

When creating a service that uses the EXTERNAL deployment controller, you\n\t\t\tcan specify only parameters that aren't controlled at the task set level. The only\n\t\t\trequired parameter is the service name. You control your services using the CreateTaskSet operation. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.

\n\t\t

When the service scheduler launches new tasks, it determines task placement in your\n\t\t\tcluster using the following logic:

\n\t\t
    \n
  • \n\t\t\t\t

    Determine which of the container instances in your cluster can support the\n\t\t\t\t\ttask definition of your service. For example, they have the required CPU,\n\t\t\t\t\tmemory, ports, and container instance attributes.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    By default, the service scheduler attempts to balance tasks across\n\t\t\t\t\tAvailability Zones in this manner. This is the case even if you can choose a\n\t\t\t\t\tdifferent placement strategy with the placementStrategy\n\t\t\t\t\tparameter.

    \n\t\t\t\t
      \n
    • \n\t\t\t\t\t\t

      Sort the valid container instances, giving priority to instances that\n\t\t\t\t\t\t\thave the fewest number of running tasks for this service in their\n\t\t\t\t\t\t\trespective Availability Zone. For example, if zone A has one running\n\t\t\t\t\t\t\tservice task and zones B and C each have zero, valid container instances\n\t\t\t\t\t\t\tin either zone B or C are considered optimal for placement.

      \n\t\t\t\t\t
      • \n
    • \n\t\t\t\t\t\t

      Place the new service task on a valid container instance in an optimal\n\t\t\t\t\t\t\tAvailability Zone based on the previous steps, favoring container\n\t\t\t\t\t\t\tinstances with the fewest number of running tasks for this\n\t\t\t\t\t\t\tservice.

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

Runs and maintains your desired number of tasks from a specified task definition. If\n\t\t\tthe number of tasks running in a service drops below the desiredCount,\n\t\t\tAmazon ECS runs another copy of the task in the specified cluster. To update an existing\n\t\t\tservice, see the UpdateService action.

\n\t\t

In addition to maintaining the desired count of tasks in your service, you can\n\t\t\toptionally run your service behind one or more load balancers. The load balancers\n\t\t\tdistribute traffic across the tasks that are associated with the service. For more\n\t\t\tinformation, see Service Load Balancing in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t

Tasks for services that don't use a load balancer are considered healthy if they're in\n\t\t\tthe RUNNING state. Tasks for services that use a load balancer are\n\t\t\tconsidered healthy if they're in the RUNNING state and are reported as healthy by the load balancer.

\n\t\t

There are two service scheduler strategies available:

\n\t\t
    \n
  • \n\t\t\t\t

    \n REPLICA - The replica scheduling strategy places and\n\t\t\t\t\tmaintains your desired number of tasks across your cluster. By default, the\n\t\t\t\t\tservice scheduler spreads tasks across Availability Zones. You can use task\n\t\t\t\t\tplacement strategies and constraints to customize task placement decisions. For\n\t\t\t\t\tmore information, see Service Scheduler Concepts in the\n\t\t\t\t\t\tAmazon Elastic Container Service Developer Guide.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n DAEMON - The daemon scheduling strategy deploys exactly one\n\t\t\t\t\ttask on each active container instance that meets all of the task placement\n\t\t\t\t\tconstraints that you specify in your cluster. The service scheduler also\n\t\t\t\t\tevaluates the task placement constraints for running tasks. It also stops tasks\n\t\t\t\t\tthat don't meet the placement constraints. When using this strategy, you don't\n\t\t\t\t\tneed to specify a desired number of tasks, a task placement strategy, or use\n\t\t\t\t\tService Auto Scaling policies. For more information, see Service Scheduler Concepts in the\n\t\t\t\t\t\tAmazon Elastic Container Service Developer Guide.

    \n\t\t\t
    • \n
\n\t\t

You can optionally specify a deployment configuration for your service. The deployment\n\t\t\tis initiated by changing properties. For example, the deployment might be initiated by\n\t\t\tthe task definition or by your desired count of a service. This is done with an UpdateService operation. The default value for a replica service for\n\t\t\t\tminimumHealthyPercent is 100%. The default value for a daemon service\n\t\t\tfor minimumHealthyPercent is 0%.

\n\t\t

If a service uses the ECS deployment controller, the minimum healthy\n\t\t\tpercent represents a lower limit on the number of tasks in a service that must remain in\n\t\t\tthe RUNNING state during a deployment. Specifically, it represents it as a\n\t\t\tpercentage of your desired number of tasks (rounded up to the nearest integer). This\n\t\t\thappens when any of your container instances are in the DRAINING state if\n\t\t\tthe service contains tasks using the EC2 launch type. Using this\n\t\t\tparameter, you can deploy without using additional cluster capacity. For example, if you\n\t\t\tset your service to have desired number of four tasks and a minimum healthy percent of\n\t\t\t50%, the scheduler might stop two existing tasks to free up cluster capacity before\n\t\t\tstarting two new tasks. If they're in the RUNNING state, tasks for services\n\t\t\tthat don't use a load balancer are considered healthy . If they're in the\n\t\t\t\tRUNNING state and reported as healthy by the load balancer, tasks for\n\t\t\tservices that do use a load balancer are considered healthy . The\n\t\t\tdefault value for minimum healthy percent is 100%.

\n\t\t

If a service uses the ECS deployment controller, the maximum percent parameter represents an upper limit on the\n\t\t\tnumber of tasks in a service that are allowed in the RUNNING or\n\t\t\t\tPENDING state during a deployment. Specifically, it represents it as a\n\t\t\tpercentage of the desired number of tasks (rounded down to the nearest integer). This\n\t\t\thappens when any of your container instances are in the DRAINING state if\n\t\t\tthe service contains tasks using the EC2 launch type. Using this\n\t\t\tparameter, you can define the deployment batch size. For example, if your service has a\n\t\t\tdesired number of four tasks and a maximum percent value of 200%, the scheduler may\n\t\t\tstart four new tasks before stopping the four older tasks (provided that the cluster\n\t\t\tresources required to do this are available). The default value for maximum percent is\n\t\t\t200%.

\n\t\t

If a service uses either the CODE_DEPLOY or EXTERNAL\n\t\t\tdeployment controller types and tasks that use the EC2 launch type, the\n\t\t\t\tminimum healthy percent and maximum percent values are used only to define the lower and upper limit\n\t\t\ton the number of the tasks in the service that remain in the RUNNING state.\n\t\t\tThis is while the container instances are in the DRAINING state. If the\n\t\t\ttasks in the service use the Fargate launch type, the minimum healthy\n\t\t\tpercent and maximum percent values aren't used. This is the case even if they're\n\t\t\tcurrently visible when describing your service.

\n\t\t

When creating a service that uses the EXTERNAL deployment controller, you\n\t\t\tcan specify only parameters that aren't controlled at the task set level. The only\n\t\t\trequired parameter is the service name. You control your services using the CreateTaskSet operation. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.

\n\t\t

When the service scheduler launches new tasks, it determines task placement in your\n\t\t\tcluster using the following logic:

\n\t\t
    \n
  • \n\t\t\t\t

    Determine which of the container instances in your cluster can support the\n\t\t\t\t\ttask definition of your service. For example, they have the required CPU,\n\t\t\t\t\tmemory, ports, and container instance attributes.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    By default, the service scheduler attempts to balance tasks across\n\t\t\t\t\tAvailability Zones in this manner. This is the case even if you can choose a\n\t\t\t\t\tdifferent placement strategy with the placementStrategy\n\t\t\t\t\tparameter.

    \n\t\t\t\t
      \n
    • \n\t\t\t\t\t\t

      Sort the valid container instances, giving priority to instances that\n\t\t\t\t\t\t\thave the fewest number of running tasks for this service in their\n\t\t\t\t\t\t\trespective Availability Zone. For example, if zone A has one running\n\t\t\t\t\t\t\tservice task and zones B and C each have zero, valid container instances\n\t\t\t\t\t\t\tin either zone B or C are considered optimal for placement.

      \n\t\t\t\t\t
      • \n
    • \n\t\t\t\t\t\t

      Place the new service task on a valid container instance in an optimal\n\t\t\t\t\t\t\tAvailability Zone based on the previous steps, favoring container\n\t\t\t\t\t\t\tinstances with the fewest number of running tasks for this\n\t\t\t\t\t\t\tservice.

      \n\t\t\t\t\t
      • \n
    \n\t\t\t
    • \n
" } }, "com.amazonaws.ecs#CreateServiceRequest": { @@ -1890,7 +1890,7 @@ "loadBalancers": { "target": "com.amazonaws.ecs#LoadBalancers", "traits": { - "smithy.api#documentation": "

A load balancer object representing the load balancers to use with your service. For\n\t\t\tmore information, see Service Load Balancing in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t

If the service uses the rolling update (ECS) deployment controller and\n\t\t\tusing either an Application Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to attach\n\t\t\tto the service. The service-linked role is required for services that use multiple\n\t\t\ttarget groups. For more information, see Using service-linked roles for Amazon ECS in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t

If the service uses the CODE_DEPLOY deployment controller, the service is\n\t\t\trequired to use either an Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment group, you\n\t\t\tspecify two target groups (referred to as a targetGroupPair). During a\n\t\t\tdeployment, CodeDeploy determines which task set in your service has the status\n\t\t\t\tPRIMARY, and it associates one target group with it. Then, it also\n\t\t\tassociates the other target group with the replacement task set. The load balancer can\n\t\t\talso have up to two listeners: a required listener for production traffic and an\n\t\t\toptional listener that you can use to perform validation tests with Lambda functions\n\t\t\tbefore routing production traffic to it.

\n\t\t

After you create a service using the ECS deployment controller, the load\n\t\t\tbalancer name or target group ARN, container name, and container port that's specified\n\t\t\tin the service definition are immutable. If you use the CODE_DEPLOY\n\t\t\tdeployment controller, these values can be changed when updating the service.

\n\t\t

For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN,\n\t\t\tthe container name, and the container port to access from the load balancer. The\n\t\t\tcontainer name must be as it appears in a container definition. The load balancer name\n\t\t\tparameter must be omitted. When a task from this service is placed on a container\n\t\t\tinstance, the container instance and port combination is registered as a target in the\n\t\t\ttarget group that's specified here.

\n\t\t

For Classic Load Balancers, this object must contain the load balancer name, the container name , and\n\t\t\tthe container port to access from the load balancer. The container name must be as it\n\t\t\tappears in a container definition. The target group ARN parameter must be omitted. When\n\t\t\ta task from this service is placed on a container instance, the container instance is\n\t\t\tregistered with the load balancer that's specified here.

\n\t\t

Services with tasks that use the awsvpc network mode (for example, those\n\t\t\twith the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers\n\t\t\taren't supported. Also, when you create any target groups for these services, you must\n\t\t\tchoose ip as the target type, not instance. This is because\n\t\t\ttasks that use the awsvpc network mode are associated with an elastic\n\t\t\tnetwork interface, not an Amazon EC2 instance.

" + "smithy.api#documentation": "

A load balancer object representing the load balancers to use with your service. For\n\t\t\tmore information, see Service Load Balancing in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t

If the service uses the rolling update (ECS) deployment controller and\n\t\t\tusing either an Application Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to attach\n\t\t\tto the service. The service-linked role is required for services that use multiple\n\t\t\ttarget groups. For more information, see Using service-linked roles for Amazon ECS in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t

If the service uses the CODE_DEPLOY deployment controller, the service is\n\t\t\trequired to use either an Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment group, you\n\t\t\tspecify two target groups (referred to as a targetGroupPair). During a\n\t\t\tdeployment, CodeDeploy determines which task set in your service has the status\n\t\t\t\tPRIMARY, and it associates one target group with it. Then, it also\n\t\t\tassociates the other target group with the replacement task set. The load balancer can\n\t\t\talso have up to two listeners: a required listener for production traffic and an\n\t\t\toptional listener that you can use to perform validation tests with Lambda functions\n\t\t\tbefore routing production traffic to it.

\n\t\t

If you use the CODE_DEPLOY deployment controller, these values can be changed\n\t\t\twhen updating the service.

\n\t\t

For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN,\n\t\t\tthe container name, and the container port to access from the load balancer. The\n\t\t\tcontainer name must be as it appears in a container definition. The load balancer name\n\t\t\tparameter must be omitted. When a task from this service is placed on a container\n\t\t\tinstance, the container instance and port combination is registered as a target in the\n\t\t\ttarget group that's specified here.

\n\t\t

For Classic Load Balancers, this object must contain the load balancer name, the container name , and\n\t\t\tthe container port to access from the load balancer. The container name must be as it\n\t\t\tappears in a container definition. The target group ARN parameter must be omitted. When\n\t\t\ta task from this service is placed on a container instance, the container instance is\n\t\t\tregistered with the load balancer that's specified here.

\n\t\t

Services with tasks that use the awsvpc network mode (for example, those\n\t\t\twith the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers\n\t\t\taren't supported. Also, when you create any target groups for these services, you must\n\t\t\tchoose ip as the target type, not instance. This is because\n\t\t\ttasks that use the awsvpc network mode are associated with an elastic\n\t\t\tnetwork interface, not an Amazon EC2 instance.

" } }, "serviceRegistries": { @@ -1962,7 +1962,7 @@ "healthCheckGracePeriodSeconds": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy\n\t\t\tElastic Load Balancing target health checks after a task has first started. This is only used when your\n\t\t\tservice is configured to use a load balancer. If your service has a load balancer\n\t\t\tdefined and you don't specify a health check grace period value, the default value of\n\t\t\t\t0 is used.

\n\t\t

If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you\n\t\t\tcan specify a health check grace period of up to\n\t\t\t2,147,483,647\n\t\t\tseconds (about 69 years). During that time, the Amazon ECS service\n\t\t\tscheduler ignores health check status. This grace period can prevent the service\n\t\t\tscheduler from marking tasks as unhealthy and stopping them before they have time to\n\t\t\tcome up.

" + "smithy.api#documentation": "

The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy\n\t\t\tElastic Load Balancing target health checks after a task has first started. This is only used when your\n\t\t\tservice is configured to use a load balancer. If your service has a load balancer\n\t\t\tdefined and you don't specify a health check grace period value, the default value of\n\t\t\t\t0 is used.

\n\t\t

If you do not use an Elastic Load Balancing, we recomend that you use the startPeriod in the task definition healtch check parameters. For more information, see Health check.

\n\t\t

If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you\n\t\t\tcan specify a health check grace period of up to\n\t\t\t2,147,483,647\n\t\t\tseconds (about 69 years). During that time, the Amazon ECS service\n\t\t\tscheduler ignores health check status. This grace period can prevent the service\n\t\t\tscheduler from marking tasks as unhealthy and stopping them before they have time to\n\t\t\tcome up.

" } }, "schedulingStrategy": { @@ -1986,13 +1986,13 @@ "enableECSManagedTags": { "target": "com.amazonaws.ecs#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For\n\t\t\tmore information, see Tagging Your Amazon ECS\n\t\t\t\tResources in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

Specifies whether to turn on Amazon ECS managed tags for the tasks within the service. For\n\t\t\tmore information, see Tagging Your Amazon ECS\n\t\t\t\tResources in the Amazon Elastic Container Service Developer Guide.

" } }, "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": { @@ -2624,20 +2624,20 @@ "enable": { "target": "com.amazonaws.ecs#Boolean", "traits": { - "smithy.api#documentation": "

Determines whether to enable the deployment circuit breaker logic for the\n\t\t\tservice.

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

Determines whether to use the deployment circuit breaker logic for the\n\t\t\tservice.

", "smithy.api#required": {} } }, "rollback": { "target": "com.amazonaws.ecs#Boolean", "traits": { - "smithy.api#documentation": "

Determines whether to enable Amazon ECS to roll back the service if a service deployment\n\t\t\tfails. If rollback is enabled, when a service deployment fails, the service is rolled\n\t\t\tback to the last deployment that completed successfully.

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

Determines whether to configure Amazon ECS to roll back the service if a service deployment\n\t\t\tfails. If rollback is enabled, when a service deployment fails, the service is rolled\n\t\t\tback to the last deployment that completed successfully.

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

The deployment circuit breaker can only be used for services using the rolling\n\t\t\t\tupdate (ECS) deployment type that aren't behind a Classic Load Balancer.

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

The deployment circuit breaker determines whether a\n\t\t\tservice deployment will fail if the service can't reach a steady state. If enabled, a\n\t\t\tservice deployment will transition to a failed state and stop launching new tasks. You\n\t\t\tcan also enable Amazon ECS to roll back your service to the last completed deployment after a\n\t\t\tfailure. For more information, see Rolling\n\t\t\t\tupdate in the Amazon Elastic Container Service Developer Guide.

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

The deployment circuit breaker can only be used for services using the rolling\n\t\t\t\tupdate (ECS) deployment type that aren't behind a Classic Load Balancer.

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

The deployment circuit breaker determines whether a\n\t\t\tservice deployment will fail if the service can't reach a steady state. If enabled, a\n\t\t\tservice deployment will transition to a failed state and stop launching new tasks. You\n\t\t\tcan also configure Amazon ECS to roll back your service to the last completed deployment after a\n\t\t\tfailure. For more information, see Rolling\n\t\t\t\tupdate in the Amazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#DeploymentConfiguration": { @@ -3638,7 +3638,7 @@ "transitEncryption": { "target": "com.amazonaws.ecs#EFSTransitEncryption", "traits": { - "smithy.api#documentation": "

Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS\n\t\t\thost and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization\n\t\t\tis used. If this parameter is omitted, the default value of DISABLED is\n\t\t\tused. For more information, see Encrypting Data in Transit in\n\t\t\tthe Amazon Elastic File System User Guide.

" + "smithy.api#documentation": "

Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS\n\t\t\thost and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization\n\t\t\tis used. If this parameter is omitted, the default value of DISABLED is\n\t\t\tused. For more information, see Encrypting Data in Transit in\n\t\t\tthe Amazon Elastic File System User Guide.

" } }, "transitEncryptionPort": { @@ -3715,7 +3715,7 @@ } }, "traits": { - "smithy.api#documentation": "

The amount of ephemeral storage to allocate for the task. This parameter is used to\n\t\t\texpand the total amount of ephemeral storage available, beyond the default amount, for\n\t\t\ttasks hosted on Fargate. For more information, see Fargate task\n\t\t\t\tstorage in the Amazon ECS User Guide for Fargate.

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

This parameter is only supported for tasks hosted on Fargate using\n\t\t\t\tthe following platform versions:

\n\t\t\t
    \n
  • \n\t\t\t\t\t

    Linux platform version 1.4.0 or later.

    \n\t\t\t\t
    • \n
  • \n\t\t\t\t\t

    Windows platform version 1.0.0 or later.

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

The amount of ephemeral storage to allocate for the task. This parameter is used to\n\t\t\texpand the total amount of ephemeral storage available, beyond the default amount, for\n\t\t\ttasks hosted on Fargate. For more information, see Fargate task\n\t\t\t\tstorage in the Amazon ECS User Guide for Fargate.

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

This parameter is only supported for tasks hosted on Fargate using Linux\n\t\t\t\tplatform version 1.4.0 or later. This parameter is not supported for\n\t\t\t\tWindows containers on Fargate.

\n\t\t " } }, "com.amazonaws.ecs#ExecuteCommand": { @@ -3788,7 +3788,7 @@ "cloudWatchEncryptionEnabled": { "target": "com.amazonaws.ecs#Boolean", "traits": { - "smithy.api#documentation": "

Determines whether to enable encryption on the CloudWatch logs. If not specified,\n\t\t\tencryption will be disabled.

" + "smithy.api#documentation": "

Determines whether to use encryption on the CloudWatch logs. If not specified,\n\t\t\tencryption will be disabled.

" } }, "s3BucketName": { @@ -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
  • \n\t\t\t\t

    \n HEALTHY-The container health check has passed\n\t\t\t\t\tsuccessfully.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n UNHEALTHY-The container health check has failed.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n UNKNOWN-The container health check is being evaluated or\n\t\t\t\t\tthere's no container health check defined.

    \n\t\t\t
    • \n
\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
  • \n\t\t\t\t

    \n HEALTHY-All essential containers within the task have\n\t\t\t\t\tpassed their health checks.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n UNHEALTHY-One or more essential containers have failed\n\t\t\t\t\ttheir health check.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n UNKNOWN-The essential containers within the task are still\n\t\t\t\t\thaving their health checks evaluated or there are no container health checks\n\t\t\t\t\tdefined.

    \n\t\t\t
    • \n
\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
    \n
  • \n\t\t\t\t

    Container health checks require version 1.17.0 or greater of the Amazon ECS\n\t\t\t\t\tcontainer agent. For more information, see Updating the\n\t\t\t\t\t\tAmazon ECS Container Agent.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    Container health checks are supported for Fargate tasks if\n\t\t\t\t\tyou're using platform version 1.1.0 or greater. For more information, see Fargate\n\t\t\t\t\t\tPlatform Versions.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    Container health checks aren't supported for tasks that are part of a service\n\t\t\t\t\tthat's configured to use a Classic Load Balancer.

    \n\t\t\t
    • \n
" + "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
  • \n\t\t\t\t

    \n HEALTHY-The container health check has passed\n\t\t\t\t\tsuccessfully.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n UNHEALTHY-The container health check has failed.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n UNKNOWN-The container health check is being evaluated or\n\t\t\t\t\tthere's no container health check defined.

    \n\t\t\t
    • \n
\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
  • \n\t\t\t\t

    \n HEALTHY-All essential containers within the task have\n\t\t\t\t\tpassed their health checks.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n UNHEALTHY-One or more essential containers have failed\n\t\t\t\t\ttheir health check.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n UNKNOWN-The essential containers within the task are still\n\t\t\t\t\thaving their health checks evaluated or there are no container health checks\n\t\t\t\t\tdefined.

    \n\t\t\t
    • \n
\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
    \n
  • \n\t\t\t\t

    Container health checks require version 1.17.0 or greater of the Amazon ECS\n\t\t\t\t\tcontainer agent. For more information, see Updating the\n\t\t\t\t\t\tAmazon ECS Container Agent.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    Container health checks are supported for Fargate tasks if\n\t\t\t\t\tyou're using platform version 1.1.0 or greater. For more information, see Fargate\n\t\t\t\t\t\tPlatform Versions.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    Container health checks aren't supported for tasks that are part of a service\n\t\t\t\t\tthat's configured to use a Classic Load Balancer.

    \n\t\t\t
    • \n
" } }, "com.amazonaws.ecs#HealthStatus": { @@ -5175,7 +5175,7 @@ } }, "traits": { - "smithy.api#documentation": "

The load balancer configuration to use with a service or task set.

\n\t\t

For specific notes and restrictions regarding the use of load balancers with services\n\t\t\tand task sets, see the CreateService and CreateTaskSet actions.

" + "smithy.api#documentation": "

The load balancer configuration to use with a service or task set.

\n\t\t

For specific notes and restrictions regarding the use of load balancers with services\n\t\t\tand task sets, see the CreateService and CreateTaskSet actions.

\n\t\t

When you add, update, or remove a load blaancer configuration, Amazon ECS starts a new\n\t\t\tdeployment with the updated Elastic Load Balancing configuration. This causes tasks to register to and\n\t\t\tderegister from load balancers.

\n\t\t

We recommend that you verify this on a test environment before you update the Elastic Load Balancing\n\t\t\tconfiguration.

\n\t\t

A service-linked role is required for services that use multiple target groups. For\n\t\t\tmore information, see Service-linked\n\t\t\t\troles in the Amazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#LoadBalancers": { @@ -5358,7 +5358,7 @@ "status": { "target": "com.amazonaws.ecs#ManagedScalingStatus", "traits": { - "smithy.api#documentation": "

Determines whether to enable managed scaling for the capacity provider.

" + "smithy.api#documentation": "

Determines whether to use managed scaling for the capacity provider.

" } }, "targetCapacity": { @@ -5859,6 +5859,10 @@ { "value": "SERVICE", "name": "SERVICE" + }, + { + "value": "NONE", + "name": "NONE" } ] } @@ -5887,7 +5891,7 @@ } }, "traits": { - "smithy.api#documentation": "

The configuration details for the App Mesh proxy.

\n\t\t

For tasks that use the EC2 launch type, the container instances require\n\t\t\tat least version 1.26.0 of the container agent and at least version 1.26.0-1 of the\n\t\t\t\tecs-init package to enable a proxy configuration. If your container\n\t\t\tinstances are launched from the Amazon ECS optimized AMI version 20190301 or\n\t\t\tlater, then they contain the required versions of the container agent and\n\t\t\t\tecs-init. For more information, see Amazon ECS-optimized Linux AMI\n\t\t

" + "smithy.api#documentation": "

The configuration details for the App Mesh proxy.

\n\t\t

For tasks that use the EC2 launch type, the container instances require\n\t\t\tat least version 1.26.0 of the container agent and at least version 1.26.0-1 of the\n\t\t\t\tecs-init package to use a proxy configuration. If your container\n\t\t\tinstances are launched from the Amazon ECS optimized AMI version 20190301 or\n\t\t\tlater, then they contain the required versions of the container agent and\n\t\t\t\tecs-init. For more information, see Amazon ECS-optimized Linux AMI\n\t\t

" } }, "com.amazonaws.ecs#ProxyConfigurationProperties": { @@ -5927,7 +5931,7 @@ } ], "traits": { - "smithy.api#documentation": "

Modifies an account setting. Account settings are set on a per-Region basis.

\n\t\t

If you change the account setting for the root user, the default settings for all of\n\t\t\tthe IAM users and roles that no individual account setting was specified are reset for.\n\t\t\tFor more information, see Account\n\t\t\t\tSettings in the Amazon Elastic Container Service Developer Guide.

\n\t\t

When serviceLongArnFormat, taskLongArnFormat, or\n\t\t\t\tcontainerInstanceLongArnFormat are specified, the Amazon Resource Name\n\t\t\t(ARN) and resource ID format of the resource type for a specified IAM user, IAM role, or\n\t\t\tthe root user for an account is affected. The opt-in and opt-out account setting must be\n\t\t\tset for each Amazon ECS resource separately. The ARN and resource ID format of a resource is\n\t\t\tdefined by the opt-in status of the IAM user or role that created the resource. You must\n\t\t\tenable this setting to use Amazon ECS features such as resource tagging.

\n\t\t

When awsvpcTrunking is specified, the elastic network interface (ENI)\n\t\t\tlimit for any new container instances that support the feature is changed. If\n\t\t\t\tawsvpcTrunking is enabled, any new container instances that support the\n\t\t\tfeature are launched have the increased ENI limits available to them. For more\n\t\t\tinformation, see Elastic Network\n\t\t\t\tInterface Trunking in the Amazon Elastic Container Service Developer Guide.

\n\t\t

When containerInsights is specified, the default setting indicating\n\t\t\twhether CloudWatch Container Insights is enabled for your clusters is changed. If\n\t\t\t\tcontainerInsights is enabled, any new clusters that are created will\n\t\t\thave Container Insights enabled unless you disable it during cluster creation. For more\n\t\t\tinformation, see CloudWatch\n\t\t\t\tContainer Insights in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

Modifies an account setting. Account settings are set on a per-Region basis.

\n\t\t

If you change the account setting for the root user, the default settings for all of\n\t\t\tthe IAM users and roles that no individual account setting was specified are reset for.\n\t\t\tFor more information, see Account\n\t\t\t\tSettings in the Amazon Elastic Container Service Developer Guide.

\n\t\t

When serviceLongArnFormat, taskLongArnFormat, or\n\t\t\t\tcontainerInstanceLongArnFormat are specified, the Amazon Resource Name\n\t\t\t(ARN) and resource ID format of the resource type for a specified IAM user, IAM role, or\n\t\t\tthe root user for an account is affected. The opt-in and opt-out account setting must be\n\t\t\tset for each Amazon ECS resource separately. The ARN and resource ID format of a resource is\n\t\t\tdefined by the opt-in status of the IAM user or role that created the resource. You must\n\t\t\tturn on this setting to use Amazon ECS features such as resource tagging.

\n\t\t

When awsvpcTrunking is specified, the elastic network interface (ENI)\n\t\t\tlimit for any new container instances that support the feature is changed. If\n\t\t\t\tawsvpcTrunking is enabled, any new container instances that support the\n\t\t\tfeature are launched have the increased ENI limits available to them. For more\n\t\t\tinformation, see Elastic Network\n\t\t\t\tInterface Trunking in the Amazon Elastic Container Service Developer Guide.

\n\t\t

When containerInsights is specified, the default setting indicating\n\t\t\twhether CloudWatch Container Insights is enabled for your clusters is changed. If\n\t\t\t\tcontainerInsights is enabled, any new clusters that are created will\n\t\t\thave Container Insights enabled unless you disable it during cluster creation. For more\n\t\t\tinformation, see CloudWatch\n\t\t\t\tContainer Insights in the Amazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#PutAccountSettingDefault": { @@ -6345,7 +6349,7 @@ "proxyConfiguration": { "target": "com.amazonaws.ecs#ProxyConfiguration", "traits": { - "smithy.api#documentation": "

The configuration details for the App Mesh proxy.

\n\t\t

For tasks hosted on Amazon EC2 instances, the container instances require at least version\n\t\t\t\t1.26.0 of the container agent and at least version\n\t\t\t\t1.26.0-1 of the ecs-init package to enable a proxy\n\t\t\tconfiguration. If your container instances are launched from the Amazon ECS-optimized\n\t\t\tAMI version 20190301 or later, then they contain the required versions of\n\t\t\tthe container agent and ecs-init. For more information, see Amazon ECS-optimized AMI versions in the\n\t\t\tAmazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The configuration details for the App Mesh proxy.

\n\t\t

For tasks hosted on Amazon EC2 instances, the container instances require at least version\n\t\t\t\t1.26.0 of the container agent and at least version\n\t\t\t\t1.26.0-1 of the ecs-init package to use a proxy\n\t\t\tconfiguration. If your container instances are launched from the Amazon ECS-optimized\n\t\t\tAMI version 20190301 or later, then they contain the required versions of\n\t\t\tthe container agent and ecs-init. For more information, see Amazon ECS-optimized AMI versions in the\n\t\t\tAmazon Elastic Container Service Developer Guide.

" } }, "inferenceAccelerators": { @@ -6588,13 +6592,13 @@ "enableECSManagedTags": { "target": "com.amazonaws.ecs#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether to enable Amazon ECS managed tags for the task. For more information, see\n\t\t\t\tTagging Your Amazon ECS\n\t\t\t\tResources in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

Specifies whether to use Amazon ECS managed tags for the task. For more information, see\n\t\t\t\tTagging Your Amazon ECS\n\t\t\t\tResources in the Amazon Elastic Container Service Developer Guide.

" } }, "enableExecuteCommand": { "target": "com.amazonaws.ecs#Boolean", "traits": { - "smithy.api#documentation": "

Determines whether to enable 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": { @@ -6666,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": {} } } @@ -6783,7 +6787,7 @@ "valueFrom": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The secret to expose to the container. The supported values are either the full ARN of\n\t\t\tthe Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store.

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

If the SSM Parameter Store parameter exists in the same Region as the task\n\t\t\t\tyou're launching, then you can use either the full ARN or name of the parameter. If\n\t\t\t\tthe parameter exists in a different Region, then the full ARN must be\n\t\t\t\tspecified.

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

The secret to expose to the container. The supported values are either the full ARN of\n\t\t\tthe Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store.

\n\t\t

For information about the require Identity and Access Management permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the Amazon Elastic Container Service Developer Guide.

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

If the SSM Parameter Store parameter exists in the same Region as the task\n\t\t\t\tyou're launching, then you can use either the full ARN or name of the parameter. If\n\t\t\t\tthe parameter exists in a different Region, then the full ARN must be\n\t\t\t\tspecified.

\n\t\t ", "smithy.api#required": {} } } @@ -6966,7 +6970,7 @@ "schedulingStrategy": { "target": "com.amazonaws.ecs#SchedulingStrategy", "traits": { - "smithy.api#documentation": "

The scheduling strategy to use for the service. For more information, see Services.

\n\t\t

There are two service scheduler strategies available.

\n\t\t
    \n
  • \n\t\t\t\t

    \n REPLICA-The replica scheduling strategy places and\n\t\t\t\t\tmaintains the desired number of tasks across your cluster. By default, the\n\t\t\t\t\tservice scheduler spreads tasks across Availability Zones. You can use task\n\t\t\t\t\tplacement strategies and constraints to customize task placement\n\t\t\t\t\tdecisions.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n DAEMON-The daemon scheduling strategy deploys exactly one\n\t\t\t\t\ttask on each active container\n\t\t\t\t\tinstance.\n\t\t\t\t\tThis taskmeets all of the task placement constraints that you\n\t\t\t\t\tspecify in your cluster. The service scheduler also evaluates the task placement\n\t\t\t\t\tconstraints for running tasks. It stop tasks that don't meet the placement\n\t\t\t\t\tconstraints.

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

    Fargate tasks don't support the DAEMON\n\t\t\t\t\t\tscheduling strategy.

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

The scheduling strategy to use for the service. For more information, see Services.

\n\t\t

There are two service scheduler strategies available.

\n\t\t
    \n
  • \n\t\t\t\t

    \n REPLICA-The replica scheduling strategy places and\n\t\t\t\t\tmaintains the desired number of tasks across your cluster. By default, the\n\t\t\t\t\tservice scheduler spreads tasks across Availability Zones. You can use task\n\t\t\t\t\tplacement strategies and constraints to customize task placement\n\t\t\t\t\tdecisions.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n DAEMON-The daemon scheduling strategy deploys exactly one task on each\n\t\t\t\t\tactive container instance. This task meets all of the task placement constraints\n\t\t\t\t\tthat you specify in your cluster. The service scheduler also evaluates the task\n\t\t\t\t\tplacement constraints for running tasks. It stop tasks that don't meet the\n\t\t\t\t\tplacement constraints.

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

    Fargate tasks don't support the DAEMON\n\t\t\t\t\t\tscheduling strategy.

    \n\t\t\t\t     \n\t\t\t
    • \n
" } }, "deploymentController": { @@ -6990,7 +6994,7 @@ "enableECSManagedTags": { "target": "com.amazonaws.ecs#Boolean", "traits": { - "smithy.api#documentation": "

Determines whether to enable Amazon ECS managed tags for the tasks in the service. For more\n\t\t\tinformation, see Tagging Your Amazon ECS\n\t\t\t\tResources in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

Determines whether to use Amazon ECS managed tags for the tasks in the service. For more\n\t\t\tinformation, see Tagging Your Amazon ECS\n\t\t\t\tResources in the Amazon Elastic Container Service Developer Guide.

" } }, "propagateTags": { @@ -7118,7 +7122,7 @@ } }, "traits": { - "smithy.api#documentation": "

The details for the service registry.

" + "smithy.api#documentation": "

The details for the service registry.

\n\t\t

Each service may be associated with one service registry. Multiple service registries for\n\t\t\teach service are not supported.

\n\t\t

When you add, update, or remove the service registries configuration, Amazon ECS starts a\n\t\t\tnew deployment. New tasks are registered and deregistered to the updated service\n\t\t\tregistry configuration.

" } }, "com.amazonaws.ecs#Services": { @@ -7139,7 +7143,7 @@ "streamUrl": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

A URL\n\t\t\tback\n\t\t\tto managed agent on the container that the SSM Session Manager client\n\t\t\tuses to send commands and receive output from the container.

" + "smithy.api#documentation": "

A URL\n\t\t\t\t\t\tto the managed agent on the container that the SSM Session Manager client\n\t\t\tuses to send commands and receive output from the container.

" } }, "tokenValue": { @@ -7287,7 +7291,7 @@ "enableECSManagedTags": { "target": "com.amazonaws.ecs#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether to enable Amazon ECS managed tags for the task. For more information, see\n\t\t\t\tTagging Your Amazon ECS\n\t\t\t\tResources in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

Specifies whether to use Amazon ECS managed tags for the task. For more information, see\n\t\t\t\tTagging Your Amazon ECS\n\t\t\t\tResources in the Amazon Elastic Container Service Developer Guide.

" } }, "enableExecuteCommand": { @@ -7837,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
  • \n

    Incorrect IAM permissions

    \n
    • \n
  • \n

    The SSM agent is not installed or is not running

    \n
    • \n
  • \n

    There is an interface Amazon VPC endpoint for Amazon ECS, but there is not one for for Systems Manager Session Manager

    \n
    • \n
\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" } }, @@ -8032,7 +8036,7 @@ "stopCode": { "target": "com.amazonaws.ecs#TaskStopCode", "traits": { - "smithy.api#documentation": "

The stop code indicating why a task was stopped. The stoppedReason might\n\t\t\tcontain additional details.

" + "smithy.api#documentation": "

The stop code indicating why a task was stopped. The stoppedReason might\n\t\t\tcontain additional details.

\n\t\t

The following are valid values:

\n\t\t
    \n
  • \n\t\t\t\t

    \n TaskFailedToStart\n

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n EssentialContainerExited\n

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n UserInitiated\n

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n TerminationNotice\n

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n ServiceSchedulerInitiated\n

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n SpotInterruption\n

    \n\t\t\t
    • \n
" } }, "stoppedAt": { @@ -8208,7 +8212,7 @@ "proxyConfiguration": { "target": "com.amazonaws.ecs#ProxyConfiguration", "traits": { - "smithy.api#documentation": "

The configuration details for the App Mesh proxy.

\n\t\t

Your Amazon ECS container instances require at least version 1.26.0 of the container agent\n\t\t\tand at least version 1.26.0-1 of the ecs-init package to enable a proxy\n\t\t\tconfiguration. If your container instances are launched from the Amazon ECS optimized AMI\n\t\t\tversion 20190301 or later, they contain the required versions of the\n\t\t\tcontainer agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The configuration details for the App Mesh proxy.

\n\t\t

Your Amazon ECS container instances require at least version 1.26.0 of the container agent\n\t\t\tand at least version 1.26.0-1 of the ecs-init package to use a proxy\n\t\t\tconfiguration. If your container instances are launched from the Amazon ECS optimized AMI\n\t\t\tversion 20190301 or later, they contain the required versions of the\n\t\t\tcontainer agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

" } }, "registeredAt": { @@ -8978,7 +8982,7 @@ "settings": { "target": "com.amazonaws.ecs#ClusterSettings", "traits": { - "smithy.api#documentation": "

The setting to use by default for a cluster. This parameter is used to enable CloudWatch\n\t\t\tContainer Insights for a cluster. If this value is specified, it overrides the\n\t\t\t\tcontainerInsights value set with PutAccountSetting or\n\t\t\t\tPutAccountSettingDefault.

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

The setting to use by default for a cluster. This parameter is used to turn on CloudWatch\n\t\t\tContainer Insights for a cluster. If this value is specified, it overrides the\n\t\t\t\tcontainerInsights value set with PutAccountSetting or\n\t\t\t\tPutAccountSettingDefault.

", "smithy.api#required": {} } } @@ -9082,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
  • \n\t\t\t\t

    If minimumHealthyPercent is below 100%, the scheduler can ignore\n\t\t\t\t\t\tdesiredCount temporarily during task replacement. For example,\n\t\t\t\t\t\tdesiredCount is four tasks, a minimum of 50% allows the\n\t\t\t\t\tscheduler to stop two existing tasks before starting two new tasks. If the\n\t\t\t\t\tminimum is 100%, the service scheduler can't remove existing tasks until the\n\t\t\t\t\treplacement tasks are considered healthy. Tasks for services that do not use a\n\t\t\t\t\tload balancer are considered healthy if they're in the RUNNING\n\t\t\t\t\tstate. Tasks for services that use a load balancer are considered healthy if\n\t\t\t\t\tthey're in the RUNNING state and the container instance they're\n\t\t\t\t\thosted on is reported as healthy by the load balancer.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    The maximumPercent parameter represents an upper limit on the\n\t\t\t\t\tnumber of running tasks during task replacement. You can use this to define the\n\t\t\t\t\treplacement batch size. For example, if desiredCount is four tasks,\n\t\t\t\t\ta maximum of 200% starts four new tasks before stopping the four tasks to be\n\t\t\t\t\tdrained, provided that the cluster resources required to do this are available.\n\t\t\t\t\tIf the maximum is 100%, then replacement tasks can't start until the draining\n\t\t\t\t\ttasks have stopped.

    \n\t\t\t
    • \n
\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
  • \n\t\t\t\t

    If minimumHealthyPercent is below 100%, the scheduler can ignore\n\t\t\t\t\t\tdesiredCount temporarily during task replacement. For example,\n\t\t\t\t\t\tdesiredCount is four tasks, a minimum of 50% allows the\n\t\t\t\t\tscheduler to stop two existing tasks before starting two new tasks. If the\n\t\t\t\t\tminimum is 100%, the service scheduler can't remove existing tasks until the\n\t\t\t\t\treplacement tasks are considered healthy. Tasks for services that do not use a\n\t\t\t\t\tload balancer are considered healthy if they're in the RUNNING\n\t\t\t\t\tstate. Tasks for services that use a load balancer are considered healthy if\n\t\t\t\t\tthey're in the RUNNING state and are reported as healthy by the\n\t\t\t\t\tload balancer.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    The maximumPercent parameter represents an upper limit on the\n\t\t\t\t\tnumber of running tasks during task replacement. You can use this to define the\n\t\t\t\t\treplacement batch size. For example, if desiredCount is four tasks,\n\t\t\t\t\ta maximum of 200% starts four new tasks before stopping the four tasks to be\n\t\t\t\t\tdrained, provided that the cluster resources required to do this are available.\n\t\t\t\t\tIf the maximum is 100%, then replacement tasks can't start until the draining\n\t\t\t\t\ttasks have stopped.

    \n\t\t\t
    • \n
\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": { @@ -9177,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) deployment controller, the\n\t\t\tdesired count, deployment configuration, network configuration, task placement\n\t\t\tconstraints and strategies, or task definition used can be updated.

\n\t\t

For services using the blue/green (CODE_DEPLOY) deployment controller,\n\t\t\tonly the desired count, deployment configuration, task placement constraints and\n\t\t\tstrategies, and health check grace period can be updated using this API. If the network\n\t\t\tconfiguration, platform version, or task definition need to be updated, a new CodeDeploy\n\t\t\tdeployment is created. 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\n\t\t\tcount, task placement constraints and strategies, and health check grace period using\n\t\t\tthis API. If the launch type, load balancer, network configuration, platform version, or\n\t\t\ttask definition need to be updated, create a new task set. For more information, see\n\t\t\t\tCreateTaskSet.

\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
  • \n\t\t\t\t

    If minimumHealthyPercent is below 100%, the scheduler can ignore\n\t\t\t\t\t\tdesiredCount temporarily during a deployment. For example, if\n\t\t\t\t\t\tdesiredCount is four tasks, a minimum of 50% allows the\n\t\t\t\t\tscheduler to stop two existing tasks before starting two new tasks. Tasks for\n\t\t\t\t\tservices that don't use a load balancer are considered healthy if they're in the\n\t\t\t\t\t\tRUNNING state. Tasks for services that use a load balancer are\n\t\t\t\t\tconsidered healthy if they're in the RUNNING state and the\n\t\t\t\t\tcontainer instance they're hosted on is reported as healthy by the load\n\t\t\t\t\tbalancer.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    The maximumPercent parameter represents an upper limit on the\n\t\t\t\t\tnumber of running tasks during a deployment. You can use it to define the\n\t\t\t\t\tdeployment batch size. For example, if desiredCount is four tasks,\n\t\t\t\t\ta maximum of 200% starts four new tasks before stopping the four older tasks\n\t\t\t\t\t(provided that the cluster resources required to do this are available).

    \n\t\t\t
    • \n
\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
  • \n\t\t\t\t

    Determine which of the container instances in your cluster can support your\n\t\t\t\t\tservice's task definition. For example, they have the required CPU, memory,\n\t\t\t\t\tports, and container instance attributes.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    By default, the service scheduler attempts to balance tasks across\n\t\t\t\t\tAvailability Zones in this manner even though you can choose a different\n\t\t\t\t\tplacement strategy.

    \n\t\t\t\t
      \n
    • \n\t\t\t\t\t\t

      Sort the valid container instances by the fewest number of running\n\t\t\t\t\t\t\ttasks for this service in the same Availability Zone as the instance.\n\t\t\t\t\t\t\tFor example, if zone A has one running service task and zones B and C\n\t\t\t\t\t\t\teach have zero, valid container instances in either zone B or C are\n\t\t\t\t\t\t\tconsidered optimal for placement.

      \n\t\t\t\t\t
      • \n
    • \n\t\t\t\t\t\t

      Place the new service task on a valid container instance in an optimal\n\t\t\t\t\t\t\tAvailability Zone (based on the previous steps), favoring container\n\t\t\t\t\t\t\tinstances with the fewest number of running tasks for this\n\t\t\t\t\t\t\tservice.

      \n\t\t\t\t\t
      • \n
    \n\t\t\t
    • \n
\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
  • \n\t\t\t\t

    Sort the container instances by the largest number of running tasks for this\n\t\t\t\t\tservice in the same Availability Zone as the instance. For example, if zone A\n\t\t\t\t\thas one running service task and zones B and C each have two, container\n\t\t\t\t\tinstances in either zone B or C are considered optimal for termination.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    Stop the task on a container instance in an optimal Availability Zone (based\n\t\t\t\t\ton the previous steps), favoring container instances with the largest number of\n\t\t\t\t\trunning tasks for this service.

    \n\t\t\t
    • \n
" + "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
  • \n\t\t\t\t

    If minimumHealthyPercent is below 100%, the scheduler can ignore\n\t\t\t\t\t\tdesiredCount temporarily during a deployment. For example, if\n\t\t\t\t\t\tdesiredCount is four tasks, a minimum of 50% allows the\n\t\t\t\t\tscheduler to stop two existing tasks before starting two new tasks. Tasks for\n\t\t\t\t\tservices that don't use a load balancer are considered healthy if they're in the\n\t\t\t\t\t\tRUNNING state. Tasks for services that use a load balancer are\n\t\t\t\t\tconsidered healthy if they're in the RUNNING state and are reported\n\t\t\t\t\tas healthy by the load balancer.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    The maximumPercent parameter represents an upper limit on the\n\t\t\t\t\tnumber of running tasks during a deployment. You can use it to define the\n\t\t\t\t\tdeployment batch size. For example, if desiredCount is four tasks,\n\t\t\t\t\ta maximum of 200% starts four new tasks before stopping the four older tasks\n\t\t\t\t\t(provided that the cluster resources required to do this are available).

    \n\t\t\t
    • \n
\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
  • \n\t\t\t\t

    Determine which of the container instances in your cluster can support your\n\t\t\t\t\tservice's task definition. For example, they have the required CPU, memory,\n\t\t\t\t\tports, and container instance attributes.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    By default, the service scheduler attempts to balance tasks across\n\t\t\t\t\tAvailability Zones in this manner even though you can choose a different\n\t\t\t\t\tplacement strategy.

    \n\t\t\t\t
      \n
    • \n\t\t\t\t\t\t

      Sort the valid container instances by the fewest number of running\n\t\t\t\t\t\t\ttasks for this service in the same Availability Zone as the instance.\n\t\t\t\t\t\t\tFor example, if zone A has one running service task and zones B and C\n\t\t\t\t\t\t\teach have zero, valid container instances in either zone B or C are\n\t\t\t\t\t\t\tconsidered optimal for placement.

      \n\t\t\t\t\t
      • \n
    • \n\t\t\t\t\t\t

      Place the new service task on a valid container instance in an optimal\n\t\t\t\t\t\t\tAvailability Zone (based on the previous steps), favoring container\n\t\t\t\t\t\t\tinstances with the fewest number of running tasks for this\n\t\t\t\t\t\t\tservice.

      \n\t\t\t\t\t
      • \n
    \n\t\t\t
    • \n
\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
  • \n\t\t\t\t

    Sort the container instances by the largest number of running tasks for this\n\t\t\t\t\tservice in the same Availability Zone as the instance. For example, if zone A\n\t\t\t\t\thas one running service task and zones B and C each have two, container\n\t\t\t\t\tinstances in either zone B or C are considered optimal for termination.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    Stop the task on a container instance in an optimal Availability Zone (based\n\t\t\t\t\ton the previous steps), favoring container instances with the largest number of\n\t\t\t\t\trunning tasks for this service.

    \n\t\t\t
    • \n
\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
  • \n\t\t\t\t

    \n loadBalancers,\n

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n serviceRegistries\n

    \n\t\t\t
    • \n
\n\t\t " } }, "com.amazonaws.ecs#UpdateServicePrimaryTaskSet": { @@ -9253,7 +9257,7 @@ "taskSet": { "target": "com.amazonaws.ecs#TaskSet", "traits": { - "smithy.api#documentation": "

Details about the task set.

" + "smithy.api#documentation": "

etails about the task set.

" } } } @@ -9339,6 +9343,30 @@ "traits": { "smithy.api#documentation": "

If true, this enables execute command functionality on all task\n\t\t\tcontainers.

\n\t\t

If you do not want to override the value that was set when the service was created,\n\t\t\tyou can set this to null when performing this action.

" } + }, + "enableECSManagedTags": { + "target": "com.amazonaws.ecs#BoxedBoolean", + "traits": { + "smithy.api#documentation": "

Determines whether to turn on Amazon ECS managed tags for the tasks in the service. For more\n\t\t\tinformation, see Tagging Your Amazon ECS\n\t\t\t\tResources in the Amazon Elastic Container Service Developer Guide.

\n\t\t

Only tasks launched after the update will reflect the update. To update the tags on\n\t\t\tall tasks, set forceNewDeployment to true, so that Amazon ECS\n\t\t\tstarts new tasks with the updated tags.

" + } + }, + "loadBalancers": { + "target": "com.amazonaws.ecs#LoadBalancers", + "traits": { + "smithy.api#documentation": "

A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the\n\t\t\tcontainer name, and the container port to access from the load balancer. The container\n\t\t\tname is as it appears in a container definition.

\n\t\t

When you add, update, or remove a load balancer configuration, Amazon ECS starts new tasks with\n\t\t\tthe updated Elastic Load Balancing configuration, and then stops the old tasks when the new tasks are\n\t\t\trunning.

\n\t\t

You can remove existing loadBalancers by passing an empty list.

" + } + }, + "propagateTags": { + "target": "com.amazonaws.ecs#PropagateTags", + "traits": { + "smithy.api#documentation": "

Determines whether to propagate the tags from the task definition or the service to\n\t\t\tthe task. If no value is specified, the tags aren't propagated.

\n\t\t

Only tasks launched after the update will reflect the update. To update the tags on\n\t\t\tall tasks, set forceNewDeployment to true, so that Amazon ECS\n\t\t\tstarts new tasks with the updated tags.

" + } + }, + "serviceRegistries": { + "target": "com.amazonaws.ecs#ServiceRegistries", + "traits": { + "smithy.api#documentation": "

The details for the service discovery registries to assign to this service. For more\n\t\t\tinformation, see Service\n\t\t\t\tDiscovery.

\n\t\t

When you add, update, or remove the service registries configuration, Amazon ECS starts new tasks\n\t\t\twith the updated service registries configuration, and then stops the old tasks when the\n\t\t\tnew tasks are running.

\n\t\t

You can remove existing serviceRegistries by passing an empty\n\t\t\tlist.

" + } } } }, diff --git a/aws/sdk/aws-models/eks.json b/aws/sdk/aws-models/eks.json index 36f95d2ae1..552940ff74 100644 --- a/aws/sdk/aws-models/eks.json +++ b/aws/sdk/aws-models/eks.json @@ -4020,6 +4020,10 @@ { "value": "ClusterUnreachable", "name": "CLUSTER_UNREACHABLE" + }, + { + "value": "Ec2SubnetMissingIpv6Assignment", + "name": "EC2_SUBNET_MISSING_IPV6_ASSIGNMENT" } ] } diff --git a/aws/sdk/aws-models/elasticache.json b/aws/sdk/aws-models/elasticache.json index 2bd9d3273f..40ec57e666 100644 --- a/aws/sdk/aws-models/elasticache.json +++ b/aws/sdk/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": { @@ -2081,7 +2081,7 @@ "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the nodes in the node group (shard).

\n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t
    \n
  • \n

    General purpose:

    \n\t\t\t\t
      \n
    • \n

      Current generation:

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

      \n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t

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

      For region availability, see Supported Node Types\n

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

      \n M5 node types:\n \t\t\t\t\t\t cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t

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

      \n M4 node types:\n \t\t\t\t\t\t cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n

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

      \n T4g node types (available only for Redis engine version 6.0 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n\t\t\t\t\t

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

      \n T3 node types:\n\t\t\t\t\t cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n

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

      \n T2 node types:\n\t\t\t\t\t cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n

      \n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t
      • \n
    • \n

      Previous generation: (not recommended)

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

      \n T1 node types:\n\t\t\t\t\t cache.t1.micro\n

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

      \n M1 node types:\n\t\t\t\t\t\t cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n

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

      \n M3 node types:\n \t\t\t\t\t\t cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n

      \n\t\t\t\t\t\t \n\t\t\t\t\t\t
      • \n
    \n
    • \n
  • \n

    Compute optimized:

    \n\n\t\t\t\t
      \n
    • \n

      Previous generation: (not recommended)

      \n\t\t\t

      \n C1 node types:\n\t\t\t cache.c1.xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Memory optimized with data tiering:

    \n\t\t
      \n
    • \n

      Current generation:

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

      \n R6gd node types (available only for Redis engine version 6.2 onward).

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

      \t\n\t\t \n\t\t cache.r6gd.xlarge,\n\t\t cache.r6gd.2xlarge,\n\t\t cache.r6gd.4xlarge,\n\t\t cache.r6gd.8xlarge,\n\t\t cache.r6gd.12xlarge,\n\t\t cache.r6gd.16xlarge\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t

      \t\t\t\t\t \n\t\t \n\t\t
      • \n
    \n
    • \n
  • \n

    Memory optimized:

    \n\t\t\t\t
      \n
    • \n

      Current generation:

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

      \n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

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

      \t\n\t\t\t\t\t\t\t cache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t

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

      For region availability, see Supported Node Types\n

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

      \n R5 node types:\n \t\t\t\t\t cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n

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

      \n R4 node types:\n \t\t\t\t\t cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n

      \n \t\t\t\t\t \n \t\t\t\t\t \n \t\t\t\t\t \n\n \n \t\t\t\t\t \n \t\t\t\t\t \n \t\t\t\t\t \n \t\t\t\t\t \n \t\t\t\t\t \n \t\t\t\t\t \n \t\t\t\t\t
      • \n
    • \n

      Previous generation: (not recommended)

      \n

      \n M2 node types:\t\t\t\t\t\t\n \t\t\t\t\t cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n

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

      \n R3 node types:\n \t\t\t\t\t cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n

      \n \t\t\t\t\t\t\n \t\t\t\t\t\t
      • \n
    \n
    • \n
\n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t
    \n
  • \n

    All current generation instance types are created in Amazon VPC by default.

    \n
    • \n
  • \n

    Redis append-only files (AOF) are not supported for T1 or T2 instances.

    \n
    • \n
  • \n

    Redis Multi-AZ with automatic failover is not supported on T1 instances.

    \n
    • \n
  • \n

    Redis configuration variables appendonly and \n\t\t\t\tappendfsync are not supported on Redis version 2.8.22 and later.

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

The compute and memory capacity of the nodes in the node group (shard).

\n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t
    \n
  • \n

    General purpose:

    \n\t\t\t\t
      \n
    • \n

      Current generation:

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

      \n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t

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

      For region availability, see Supported Node Types\n

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

      \n M5 node types:\n \t\t\t\t\t\t cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t

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

      \n M4 node types:\n \t\t\t\t\t\t cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n

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

      \n T4g node types (available only for Redis engine version 6.0 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n\t\t\t\t\t

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

      \n T3 node types:\n\t\t\t\t\t cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n

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

      \n T2 node types:\n\t\t\t\t\t cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n

      \n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t
      • \n
    • \n

      Previous generation: (not recommended)

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

      \n T1 node types:\n\t\t\t\t\t cache.t1.micro\n

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

      \n M1 node types:\n\t\t\t\t\t\t cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n

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

      \n M3 node types:\n \t\t\t\t\t\t cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n

      \n\t\t\t\t\t\t \n\t\t\t\t\t\t
      • \n
    \n
    • \n
  • \n

    Compute optimized:

    \n\n\t\t\t\t
      \n
    • \n

      Previous generation: (not recommended)

      \n\t\t\t

      \n C1 node types:\n\t\t\t cache.c1.xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Memory optimized:

    \n\t\t\t\t
      \n
    • \n

      Current generation:

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

      \n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

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

      \t\n\t\t\t\t\t\t\t cache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t

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

      For region availability, see Supported Node Types\n

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

      \n R5 node types:\n \t\t\t\t\t cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n

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

      \n R4 node types:\n \t\t\t\t\t cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n

      \n \t\t\t\t\t \n \t\t\t\t\t \n \t\t\t\t\t \n\n \n \t\t\t\t\t \n \t\t\t\t\t \n \t\t\t\t\t \n \t\t\t\t\t \n \t\t\t\t\t \n \t\t\t\t\t \n \t\t\t\t\t
      • \n
    • \n

      Previous generation: (not recommended)

      \n

      \n M2 node types:\t\t\t\t\t\t\n \t\t\t\t\t cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n

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

      \n R3 node types:\n \t\t\t\t\t cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n

      \n \t\t\t\t\t\t\n \t\t\t\t\t\t
      • \n
    \n
    • \n
\n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t
    \n
  • \n

    All current generation instance types are created in Amazon VPC by default.

    \n
    • \n
  • \n

    Redis append-only files (AOF) are not supported for T1 or T2 instances.

    \n
    • \n
  • \n

    Redis Multi-AZ with automatic failover is not supported on T1 instances.

    \n
    • \n
  • \n

    Redis configuration variables appendonly and \n\t\t\t\tappendfsync are not supported on Redis version 2.8.22 and later.

    \n
    • \n
" } }, "Engine": { @@ -5256,7 +5256,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/aws/sdk/aws-models/finspace-data.json b/aws/sdk/aws-models/finspace-data.json index 1011253ed4..dd67dfc5e2 100644 --- a/aws/sdk/aws-models/finspace-data.json +++ b/aws/sdk/aws-models/finspace-data.json @@ -57,9 +57,24 @@ { "target": "com.amazonaws.finspacedata#CreateDataView" }, + { + "target": "com.amazonaws.finspacedata#CreatePermissionGroup" + }, + { + "target": "com.amazonaws.finspacedata#CreateUser" + }, { "target": "com.amazonaws.finspacedata#DeleteDataset" }, + { + "target": "com.amazonaws.finspacedata#DeletePermissionGroup" + }, + { + "target": "com.amazonaws.finspacedata#DisableUser" + }, + { + "target": "com.amazonaws.finspacedata#EnableUser" + }, { "target": "com.amazonaws.finspacedata#GetChangeset" }, @@ -72,6 +87,9 @@ { "target": "com.amazonaws.finspacedata#GetProgrammaticAccessCredentials" }, + { + "target": "com.amazonaws.finspacedata#GetUser" + }, { "target": "com.amazonaws.finspacedata#GetWorkingLocation" }, @@ -84,11 +102,26 @@ { "target": "com.amazonaws.finspacedata#ListDataViews" }, + { + "target": "com.amazonaws.finspacedata#ListPermissionGroups" + }, + { + "target": "com.amazonaws.finspacedata#ListUsers" + }, + { + "target": "com.amazonaws.finspacedata#ResetUserPassword" + }, { "target": "com.amazonaws.finspacedata#UpdateChangeset" }, { "target": "com.amazonaws.finspacedata#UpdateDataset" + }, + { + "target": "com.amazonaws.finspacedata#UpdatePermissionGroup" + }, + { + "target": "com.amazonaws.finspacedata#UpdateUser" } ] }, @@ -115,6 +148,62 @@ "smithy.api#pattern": "^alias\\/\\S+$" } }, + "com.amazonaws.finspacedata#ApiAccess": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ENABLED", + "name": "ENABLED" + }, + { + "value": "DISABLED", + "name": "DISABLED" + } + ] + } + }, + "com.amazonaws.finspacedata#ApplicationPermission": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CreateDataset", + "name": "CreateDataset" + }, + { + "value": "ManageClusters", + "name": "ManageClusters" + }, + { + "value": "ManageUsersAndGroups", + "name": "ManageUsersAndGroups" + }, + { + "value": "ManageAttributeSets", + "name": "ManageAttributeSets" + }, + { + "value": "ViewAuditData", + "name": "ViewAuditData" + }, + { + "value": "AccessNotebooks", + "name": "AccessNotebooks" + }, + { + "value": "GetTemporaryCredentials", + "name": "GetTemporaryCredentials" + } + ] + } + }, + "com.amazonaws.finspacedata#ApplicationPermissionList": { + "type": "list", + "member": { + "target": "com.amazonaws.finspacedata#ApplicationPermission" + } + }, "com.amazonaws.finspacedata#Boolean": { "type": "boolean", "traits": { @@ -159,7 +248,7 @@ "errorCategory": { "target": "com.amazonaws.finspacedata#ErrorCategory", "traits": { - "smithy.api#documentation": "

The category of the error.

\n
    \n
  • \n

    \n VALIDATION -The inputs to this request are invalid.

    \n
    • \n
  • \n

    \n SERVICE_QUOTA_EXCEEDED - Service quotas have been exceeded. Please\n contact AWS support to increase quotas.

    \n
    • \n
  • \n

    \n ACCESS_DENIED - Missing required permission to perform this\n request.

    \n
    • \n
  • \n

    \n RESOURCE_NOT_FOUND - One or more inputs to this request were not\n found.

    \n
    • \n
  • \n

    \n THROTTLING - The system temporarily lacks sufficient resources to process\n the request.

    \n
    • \n
  • \n

    \n INTERNAL_SERVICE_EXCEPTION - An internal service error has\n occurred.

    \n
    • \n
  • \n

    \n CANCELLED - Cancelled.

    \n
    • \n
  • \n

    \n USER_RECOVERABLE - A user recoverable error has occurred.

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

The category of the error.

\n
    \n
  • \n

    \n VALIDATION – The inputs to this request are invalid.

    \n
    • \n
  • \n

    \n SERVICE_QUOTA_EXCEEDED – Service quotas have been exceeded. Please\n contact AWS support to increase quotas.

    \n
    • \n
  • \n

    \n ACCESS_DENIED – Missing required permission to perform this\n request.

    \n
    • \n
  • \n

    \n RESOURCE_NOT_FOUND – One or more inputs to this request were not\n found.

    \n
    • \n
  • \n

    \n THROTTLING – The system temporarily lacks sufficient resources to process\n the request.

    \n
    • \n
  • \n

    \n INTERNAL_SERVICE_EXCEPTION – An internal service error has\n occurred.

    \n
    • \n
  • \n

    \n CANCELLED – Cancelled.

    \n
    • \n
  • \n

    \n USER_RECOVERABLE – A user recoverable error has occurred.

    \n
    • \n
" } } }, @@ -210,7 +299,7 @@ "changeType": { "target": "com.amazonaws.finspacedata#ChangeType", "traits": { - "smithy.api#documentation": "

Type that indicates how a Changeset is applied to a Dataset.

\n
    \n
  • \n

    \n REPLACE - Changeset is considered as a replacement to all prior loaded\n Changesets.

    \n
    • \n
  • \n

    \n APPEND - Changeset is considered as an addition to the end of all prior\n loaded Changesets.

    \n
    • \n
  • \n

    \n MODIFY - Changeset is considered as a replacement to a specific prior\n ingested Changeset.

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

Type that indicates how a Changeset is applied to a Dataset.

\n
    \n
  • \n

    \n REPLACE – Changeset is considered as a replacement to all prior loaded\n Changesets.

    \n
    • \n
  • \n

    \n APPEND – Changeset is considered as an addition to the end of all prior\n loaded Changesets.

    \n
    • \n
  • \n

    \n MODIFY – Changeset is considered as a replacement to a specific prior\n ingested Changeset.

    \n
    • \n
" } }, "sourceParams": { @@ -228,13 +317,13 @@ "createTime": { "target": "com.amazonaws.finspacedata#TimestampEpoch", "traits": { - "smithy.api#documentation": "

The timestamp at which the Changeset was created in FinSpace. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

" + "smithy.api#documentation": "

The timestamp at which the Changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

" } }, "status": { "target": "com.amazonaws.finspacedata#IngestionStatus", "traits": { - "smithy.api#documentation": "

Status of the Changeset ingestion.

\n
    \n
  • \n

    \n PENDING - Changeset is pending creation.

    \n
    • \n
  • \n

    \n FAILED - Changeset creation has failed.

    \n
    • \n
  • \n

    \n SUCCESS - Changeset creation has succeeded.

    \n
    • \n
  • \n

    \n RUNNING - Changeset creation is running.

    \n
    • \n
  • \n

    \n STOP_REQUESTED - User requested Changeset creation to stop.

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

Status of the Changeset ingestion.

\n
    \n
  • \n

    \n PENDING – Changeset is pending creation.

    \n
    • \n
  • \n

    \n FAILED – Changeset creation has failed.

    \n
    • \n
  • \n

    \n SUCCESS – Changeset creation has succeeded.

    \n
    • \n
  • \n

    \n RUNNING – Changeset creation is running.

    \n
    • \n
  • \n

    \n STOP_REQUESTED – User requested Changeset creation to stop.

    \n
    • \n
" } }, "errorInfo": { @@ -247,14 +336,14 @@ "target": "com.amazonaws.finspacedata#TimestampEpoch", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

Time until which the Changeset is active. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

" + "smithy.api#documentation": "

Time until which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

" } }, "activeFromTimestamp": { "target": "com.amazonaws.finspacedata#TimestampEpoch", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

Beginning time from which the Changeset is active. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

" + "smithy.api#documentation": "

Beginning time from which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

" } }, "updatesChangesetId": { @@ -347,13 +436,13 @@ "dataType": { "target": "com.amazonaws.finspacedata#ColumnDataType", "traits": { - "smithy.api#documentation": "

Data type of a column.

\n
    \n
  • \n

    \n STRING - A String data type.

    \n

    \n CHAR - A char data type.

    \n

    \n INTEGER - An integer data type.

    \n

    \n TINYINT - A tinyint data type.

    \n

    \n SMALLINT - A smallint data type.

    \n

    \n BIGINT - A bigint data type.

    \n

    \n FLOAT - A float data type.

    \n

    \n DOUBLE - A double data type.

    \n

    \n DATE - A date data type.

    \n

    \n DATETIME - A datetime data type.

    \n

    \n BOOLEAN - A boolean data type.

    \n

    \n BINARY - A binary data type.

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

Data type of a column.

\n
    \n
  • \n

    \n STRING – A String data type.

    \n

    \n CHAR – A char data type.

    \n

    \n INTEGER – An integer data type.

    \n

    \n TINYINT – A tinyint data type.

    \n

    \n SMALLINT – A smallint data type.

    \n

    \n BIGINT – A bigint data type.

    \n

    \n FLOAT – A float data type.

    \n

    \n DOUBLE – A double data type.

    \n

    \n DATE – A date data type.

    \n

    \n DATETIME – A datetime data type.

    \n

    \n BOOLEAN – A boolean data type.

    \n

    \n BINARY – A binary data type.

    \n
    • \n
" } }, "columnName": { "target": "com.amazonaws.finspacedata#ColumnName", "traits": { - "smithy.api#documentation": "

Name for a column.

" + "smithy.api#documentation": "

The name of a column.

" } }, "columnDescription": { @@ -412,6 +501,9 @@ "members": { "message": { "target": "com.amazonaws.finspacedata#ErrorMessage2" + }, + "reason": { + "target": "com.amazonaws.finspacedata#ErrorMessage2" } }, "traits": { @@ -481,21 +573,21 @@ "changeType": { "target": "com.amazonaws.finspacedata#ChangeType", "traits": { - "smithy.api#documentation": "

Option to indicate how a Changeset will be applied to a Dataset.

\n
    \n
  • \n

    \n REPLACE - Changeset will be considered as a replacement to all prior\n loaded Changesets.

    \n
    • \n
  • \n

    \n APPEND - Changeset will be considered as an addition to the end of all\n prior loaded Changesets.

    \n
    • \n
  • \n

    \n MODIFY - Changeset is considered as a replacement to a specific prior ingested Changeset.

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

The option to indicate how a Changeset will be applied to a Dataset.

\n
    \n
  • \n

    \n REPLACE – Changeset will be considered as a replacement to all prior\n loaded Changesets.

    \n
    • \n
  • \n

    \n APPEND – Changeset will be considered as an addition to the end of all\n prior loaded Changesets.

    \n
    • \n
  • \n

    \n MODIFY – Changeset is considered as a replacement to a specific prior ingested Changeset.

    \n
    • \n
", "smithy.api#required": {} } }, "sourceParams": { "target": "com.amazonaws.finspacedata#SourceParams", "traits": { - "smithy.api#documentation": "

Options that define the location of the data being ingested (s3SourcePath) and the source of the changeset (sourceType).

\n

Both s3SourcePath and sourceType are required attributes.

\n

Here is an example of how you could specify the sourceParams:

\n

\n \n \"sourceParams\": \n {\n \"s3SourcePath\": \"s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv\",\n \"sourceType\": \"S3\"\n }\n \n

\n

The S3 path that you specify must allow the FinSpace role access. To do that, you first need to configure the IAM policy on S3 bucket. For more information, see Loading data from an Amazon S3 Bucket using the FinSpace APIsection.

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

Options that define the location of the data being ingested (s3SourcePath) and the source of the changeset (sourceType).

\n

Both s3SourcePath and sourceType are required attributes.

\n

Here is an example of how you could specify the sourceParams:

\n

\n \n \"sourceParams\": \n {\n \"s3SourcePath\": \"s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv\",\n \"sourceType\": \"S3\"\n }\n \n

\n

The S3 path that you specify must allow the FinSpace role access. To do that, you first need to configure the IAM policy on S3 bucket. For more information, see Loading data from an Amazon S3 Bucket using the FinSpace API section.

", "smithy.api#required": {} } }, "formatParams": { "target": "com.amazonaws.finspacedata#FormatParams", "traits": { - "smithy.api#documentation": "

Options that define the structure of the source file(s) including the format type (formatType), header row (withHeader), data separation character (separator) and the type of compression (compression).\n

\n

\n formatType is a required attribute and can have the following values:\n

\n
    \n
  • \n

    \n PARQUET - Parquet source file format.

    \n
    • \n
  • \n

    \n CSV - CSV source file format.

    \n
    • \n
  • \n

    \n JSON - JSON source file format.

    \n
    • \n
  • \n

    \n XML - XML source file format.

    \n
    • \n
\n \n

Here is an example of how you could specify the formatParams:

\n

\n \n \"formatParams\": \n {\n \"formatType\": \"CSV\",\n \"withHeader\": \"true\",\n \"separator\": \",\",\n \"compression\":\"None\"\n } \n \n

\n

Note that if you only provide formatType as CSV, the rest of the attributes will automatically default to CSV values as following:

\n

\n \n {\n \"withHeader\": \"true\",\n \"separator\": \",\"\n }\n \n

\n

For more information about supported file formats, see Supported Data Types and File Formats in the FinSpace User Guide.

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

Options that define the structure of the source file(s) including the format type (formatType), header row (withHeader), data separation character (separator) and the type of compression (compression).\n

\n

\n formatType is a required attribute and can have the following values:\n

\n
    \n
  • \n

    \n PARQUET – Parquet source file format.

    \n
    • \n
  • \n

    \n CSV – CSV source file format.

    \n
    • \n
  • \n

    \n JSON – JSON source file format.

    \n
    • \n
  • \n

    \n XML – XML source file format.

    \n
    • \n
\n \n

Here is an example of how you could specify the formatParams:

\n

\n \n \"formatParams\": \n {\n \"formatType\": \"CSV\",\n \"withHeader\": \"true\",\n \"separator\": \",\",\n \"compression\":\"None\"\n } \n \n

\n

Note that if you only provide formatType as CSV, the rest of the attributes will automatically default to CSV values as following:

\n

\n \n {\n \"withHeader\": \"true\",\n \"separator\": \",\"\n }\n \n

\n

For more information about supported file formats, see Supported Data Types and File Formats in the FinSpace User Guide.

", "smithy.api#required": {} } } @@ -601,7 +693,7 @@ "target": "com.amazonaws.finspacedata#TimestampEpoch", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

Beginning time to use for the Dataview. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

" + "smithy.api#documentation": "

Beginning time to use for the Dataview. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

" } }, "destinationTypeParams": { @@ -696,7 +788,7 @@ "kind": { "target": "com.amazonaws.finspacedata#DatasetKind", "traits": { - "smithy.api#documentation": "

The format in which Dataset data is structured.

\n
    \n
  • \n

    \n TABULAR - Data is structured in a tabular format.

    \n
    • \n
  • \n

    \n NON_TABULAR - Data is structured in a non-tabular format.

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

The format in which Dataset data is structured.

\n
    \n
  • \n

    \n TABULAR – Data is structured in a tabular format.

    \n
    • \n
  • \n

    \n NON_TABULAR – Data is structured in a non-tabular format.

    \n
    • \n
", "smithy.api#required": {} } }, @@ -750,6 +842,184 @@ "smithy.api#documentation": "The response from a CreateDataset operation" } }, + "com.amazonaws.finspacedata#CreatePermissionGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspacedata#CreatePermissionGroupRequest" + }, + "output": { + "target": "com.amazonaws.finspacedata#CreatePermissionGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspacedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspacedata#ConflictException" + }, + { + "target": "com.amazonaws.finspacedata#InternalServerException" + }, + { + "target": "com.amazonaws.finspacedata#LimitExceededException" + }, + { + "target": "com.amazonaws.finspacedata#ThrottlingException" + }, + { + "target": "com.amazonaws.finspacedata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a group of permissions for various actions that a user can perform in FinSpace.

", + "smithy.api#http": { + "method": "POST", + "uri": "/permission-group", + "code": 200 + } + } + }, + "com.amazonaws.finspacedata#CreatePermissionGroupRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.finspacedata#PermissionGroupName", + "traits": { + "smithy.api#documentation": "

The name of the permission group.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.finspacedata#PermissionGroupDescription", + "traits": { + "smithy.api#documentation": "

A brief description for the permission group.

" + } + }, + "applicationPermissions": { + "target": "com.amazonaws.finspacedata#ApplicationPermissionList", + "traits": { + "smithy.api#documentation": "

The option to indicate FinSpace application permissions that are granted to a specific group.

\n
    \n
  • \n

    \n CreateDataset – Group members can create new datasets.

    \n
    • \n
  • \n

    \n ManageClusters – Group members can manage Apache Spark clusters from FinSpace notebooks.

    \n
    • \n
  • \n

    \n ManageUsersAndGroups – Group members can manage users and permission groups.

    \n
    • \n
  • \n

    \n ManageAttributeSets – Group members can manage attribute sets.

    \n
    • \n
  • \n

    \n ViewAuditData – Group members can view audit data.

    \n
    • \n
  • \n

    \n AccessNotebooks – Group members will have access to FinSpace notebooks.

    \n
    • \n
  • \n

    \n GetTemporaryCredentials – Group members can get temporary API credentials.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.finspacedata#ClientToken", + "traits": { + "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.finspacedata#CreatePermissionGroupResponse": { + "type": "structure", + "members": { + "permissionGroupId": { + "target": "com.amazonaws.finspacedata#PermissionGroupId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the permission group.

" + } + } + } + }, + "com.amazonaws.finspacedata#CreateUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspacedata#CreateUserRequest" + }, + "output": { + "target": "com.amazonaws.finspacedata#CreateUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspacedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspacedata#ConflictException" + }, + { + "target": "com.amazonaws.finspacedata#InternalServerException" + }, + { + "target": "com.amazonaws.finspacedata#LimitExceededException" + }, + { + "target": "com.amazonaws.finspacedata#ThrottlingException" + }, + { + "target": "com.amazonaws.finspacedata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new user in FinSpace.

", + "smithy.api#http": { + "method": "POST", + "uri": "/user", + "code": 200 + } + } + }, + "com.amazonaws.finspacedata#CreateUserRequest": { + "type": "structure", + "members": { + "emailAddress": { + "target": "com.amazonaws.finspacedata#Email", + "traits": { + "smithy.api#documentation": "

The email address of the user that you want to register. The email address serves as a uniquer identifier for each user and cannot be changed after it's created.

", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.finspacedata#UserType", + "traits": { + "smithy.api#documentation": "

The option to indicate the type of user. Use one of the following options to specify this parameter:

\n
    \n
  • \n

    \n SUPER_USER – A user with permission to all the functionality and data in FinSpace.

    \n
    • \n
  • \n

    \n APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "firstName": { + "target": "com.amazonaws.finspacedata#FirstName", + "traits": { + "smithy.api#documentation": "

The first name of the user that you want to register.

" + } + }, + "lastName": { + "target": "com.amazonaws.finspacedata#LastName", + "traits": { + "smithy.api#documentation": "

The last name of the user that you want to register.

" + } + }, + "ApiAccess": { + "target": "com.amazonaws.finspacedata#ApiAccess", + "traits": { + "smithy.api#documentation": "

The option to indicate whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.

\n
    \n
  • \n

    \n ENABLED – The user has permissions to use the APIs.

    \n
    • \n
  • \n

    \n DISABLED – The user does not have permissions to use any APIs.

    \n
    • \n
" + } + }, + "apiAccessPrincipalArn": { + "target": "com.amazonaws.finspacedata#RoleArn", + "traits": { + "smithy.api#documentation": "

The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.

" + } + }, + "clientToken": { + "target": "com.amazonaws.finspacedata#ClientToken", + "traits": { + "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.finspacedata#CreateUserResponse": { + "type": "structure", + "members": { + "userId": { + "target": "com.amazonaws.finspacedata#UserId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the user.

" + } + } + } + }, "com.amazonaws.finspacedata#Credentials": { "type": "structure", "members": { @@ -794,14 +1064,14 @@ "destinationType": { "target": "com.amazonaws.finspacedata#DataViewDestinationType", "traits": { - "smithy.api#documentation": "

Destination type for a Dataview.

\n
    \n
  • \n

    \n GLUE_TABLE - Glue table destination type.

    \n
    • \n
  • \n

    \n S3 - S3 destination type.

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

Destination type for a Dataview.

\n
    \n
  • \n

    \n GLUE_TABLE – Glue table destination type.

    \n
    • \n
  • \n

    \n S3 – S3 destination type.

    \n
    • \n
", "smithy.api#required": {} } }, "s3DestinationExportFileFormat": { "target": "com.amazonaws.finspacedata#ExportFileFormat", "traits": { - "smithy.api#documentation": "

Data view export file format.

\n
    \n
  • \n

    \n PARQUET - Parquet export file format.

    \n
    • \n
  • \n

    \n DELIMITED_TEXT - Delimited text export file format.

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

Data view export file format.

\n
    \n
  • \n

    \n PARQUET – Parquet export file format.

    \n
    • \n
  • \n

    \n DELIMITED_TEXT – Delimited text export file format.

    \n
    • \n
" } }, "s3DestinationExportFileFormatOptions": { @@ -827,7 +1097,7 @@ "errorCategory": { "target": "com.amazonaws.finspacedata#ErrorCategory", "traits": { - "smithy.api#documentation": "

The category of the error.

\n
    \n
  • \n

    \n VALIDATION -The inputs to this request are invalid.

    \n
    • \n
  • \n

    \n SERVICE_QUOTA_EXCEEDED - Service quotas have been exceeded. Please\n contact AWS support to increase quotas.

    \n
    • \n
  • \n

    \n ACCESS_DENIED - Missing required permission to perform this\n request.

    \n
    • \n
  • \n

    \n RESOURCE_NOT_FOUND - One or more inputs to this request were not\n found.

    \n
    • \n
  • \n

    \n THROTTLING - The system temporarily lacks sufficient resources to process\n the request.

    \n
    • \n
  • \n

    \n INTERNAL_SERVICE_EXCEPTION - An internal service error has\n occurred.

    \n
    • \n
  • \n

    \n CANCELLED - Cancelled.

    \n
    • \n
  • \n

    \n USER_RECOVERABLE - A user recoverable error has occurred.

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

The category of the error.

\n
    \n
  • \n

    \n VALIDATION – The inputs to this request are invalid.

    \n
    • \n
  • \n

    \n SERVICE_QUOTA_EXCEEDED – Service quotas have been exceeded. Please\n contact AWS support to increase quotas.

    \n
    • \n
  • \n

    \n ACCESS_DENIED – Missing required permission to perform this\n request.

    \n
    • \n
  • \n

    \n RESOURCE_NOT_FOUND – One or more inputs to this request were not\n found.

    \n
    • \n
  • \n

    \n THROTTLING – The system temporarily lacks sufficient resources to process\n the request.

    \n
    • \n
  • \n

    \n INTERNAL_SERVICE_EXCEPTION – An internal service error has\n occurred.

    \n
    • \n
  • \n

    \n CANCELLED – Cancelled.

    \n
    • \n
  • \n

    \n USER_RECOVERABLE – A user recoverable error has occurred.

    \n
    • \n
" } } }, @@ -919,7 +1189,7 @@ "target": "com.amazonaws.finspacedata#TimestampEpoch", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

Time range to use for the Dataview. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

" + "smithy.api#documentation": "

Time range to use for the Dataview. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

" } }, "partitionColumns": { @@ -937,7 +1207,7 @@ "status": { "target": "com.amazonaws.finspacedata#DataViewStatus", "traits": { - "smithy.api#documentation": "

The status of a Dataview creation.

\n
    \n
  • \n

    \n RUNNING - Dataview creation is running.

    \n
    • \n
  • \n

    \n STARTING - Dataview creation is starting.

    \n
    • \n
  • \n

    \n FAILED - Dataview creation has failed.

    \n
    • \n
  • \n

    \n CANCELLED - Dataview creation has been cancelled.

    \n
    • \n
  • \n

    \n TIMEOUT - Dataview creation has timed out.

    \n
    • \n
  • \n

    \n SUCCESS - Dataview creation has succeeded.

    \n
    • \n
  • \n

    \n PENDING - Dataview creation is pending.

    \n
    • \n
  • \n

    \n FAILED_CLEANUP_FAILED - Dataview creation failed and resource cleanup failed.

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

The status of a Dataview creation.

\n
    \n
  • \n

    \n RUNNING – Dataview creation is running.

    \n
    • \n
  • \n

    \n STARTING – Dataview creation is starting.

    \n
    • \n
  • \n

    \n FAILED – Dataview creation has failed.

    \n
    • \n
  • \n

    \n CANCELLED – Dataview creation has been cancelled.

    \n
    • \n
  • \n

    \n TIMEOUT – Dataview creation has timed out.

    \n
    • \n
  • \n

    \n SUCCESS – Dataview creation has succeeded.

    \n
    • \n
  • \n

    \n PENDING – Dataview creation is pending.

    \n
    • \n
  • \n

    \n FAILED_CLEANUP_FAILED – Dataview creation failed and resource cleanup failed.

    \n
    • \n
" } }, "errorInfo": { @@ -961,13 +1231,13 @@ "createTime": { "target": "com.amazonaws.finspacedata#TimestampEpoch", "traits": { - "smithy.api#documentation": "

The timestamp at which the Dataview was created in FinSpace. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

" + "smithy.api#documentation": "

The timestamp at which the Dataview was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

" } }, "lastModifiedTime": { "target": "com.amazonaws.finspacedata#TimestampEpoch", "traits": { - "smithy.api#documentation": "

The last time that a Dataview was modified. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

" + "smithy.api#documentation": "

The last time that a Dataview was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

" } } }, @@ -999,7 +1269,7 @@ "kind": { "target": "com.amazonaws.finspacedata#DatasetKind", "traits": { - "smithy.api#documentation": "

The format in which Dataset data is structured.

\n
    \n
  • \n

    \n TABULAR - Data is structured in a tabular format.

    \n
    • \n
  • \n

    \n NON_TABULAR - Data is structured in a non-tabular format.

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

The format in which Dataset data is structured.

\n
    \n
  • \n

    \n TABULAR – Data is structured in a tabular format.

    \n
    • \n
  • \n

    \n NON_TABULAR – Data is structured in a non-tabular format.

    \n
    • \n
" } }, "datasetDescription": { @@ -1017,13 +1287,13 @@ "createTime": { "target": "com.amazonaws.finspacedata#TimestampEpoch", "traits": { - "smithy.api#documentation": "

The timestamp at which the Dataset was created in FinSpace. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

" + "smithy.api#documentation": "

The timestamp at which the Dataset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

" } }, "lastModifiedTime": { "target": "com.amazonaws.finspacedata#TimestampEpoch", "traits": { - "smithy.api#documentation": "

The last time that the Dataset was modified. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

" + "smithy.api#documentation": "

The last time that the Dataset was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

" } }, "schemaDefinition": { @@ -1101,7 +1371,7 @@ "name": { "target": "com.amazonaws.finspacedata#OwnerName", "traits": { - "smithy.api#documentation": "

Name of the Dataset owner.

" + "smithy.api#documentation": "

The name of the Dataset owner.

" } }, "phoneNumber": { @@ -1234,24 +1504,235 @@ "smithy.api#documentation": "The response from an DeleteDataset operation" } }, - "com.amazonaws.finspacedata#Email": { - "type": "string", + "com.amazonaws.finspacedata#DeletePermissionGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspacedata#DeletePermissionGroupRequest" + }, + "output": { + "target": "com.amazonaws.finspacedata#DeletePermissionGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspacedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspacedata#ConflictException" + }, + { + "target": "com.amazonaws.finspacedata#InternalServerException" + }, + { + "target": "com.amazonaws.finspacedata#LimitExceededException" + }, + { + "target": "com.amazonaws.finspacedata#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspacedata#ThrottlingException" + }, + { + "target": "com.amazonaws.finspacedata#ValidationException" + } + ], "traits": { - "smithy.api#documentation": "Email of Dataset Owner", - "smithy.api#length": { - "min": 4, - "max": 320 + "smithy.api#documentation": "

Deletes a permission group. This action is irreversible.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/permission-group/{permissionGroupId}", + "code": 200 + } + } + }, + "com.amazonaws.finspacedata#DeletePermissionGroupRequest": { + "type": "structure", + "members": { + "permissionGroupId": { + "target": "com.amazonaws.finspacedata#PermissionGroupId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the permission group that you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } }, - "smithy.api#pattern": "^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,4}$" + "clientToken": { + "target": "com.amazonaws.finspacedata#ClientToken", + "traits": { + "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + } } }, - "com.amazonaws.finspacedata#ErrorCategory": { - "type": "string", - "traits": { - "smithy.api#documentation": "Changeset Error Category", - "smithy.api#enum": [ - { - "value": "VALIDATION", + "com.amazonaws.finspacedata#DeletePermissionGroupResponse": { + "type": "structure", + "members": { + "permissionGroupId": { + "target": "com.amazonaws.finspacedata#PermissionGroupId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the deleted permission group.

" + } + } + } + }, + "com.amazonaws.finspacedata#DisableUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspacedata#DisableUserRequest" + }, + "output": { + "target": "com.amazonaws.finspacedata#DisableUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspacedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspacedata#ConflictException" + }, + { + "target": "com.amazonaws.finspacedata#InternalServerException" + }, + { + "target": "com.amazonaws.finspacedata#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspacedata#ThrottlingException" + }, + { + "target": "com.amazonaws.finspacedata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Denies access to the FinSpace web application and API for the specified user.

", + "smithy.api#http": { + "method": "POST", + "uri": "/user/{userId}/disable", + "code": 200 + } + } + }, + "com.amazonaws.finspacedata#DisableUserRequest": { + "type": "structure", + "members": { + "userId": { + "target": "com.amazonaws.finspacedata#UserId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the user account that you want to disable.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.finspacedata#ClientToken", + "traits": { + "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.finspacedata#DisableUserResponse": { + "type": "structure", + "members": { + "userId": { + "target": "com.amazonaws.finspacedata#UserId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the disabled user account.

" + } + } + } + }, + "com.amazonaws.finspacedata#Email": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 320 + }, + "smithy.api#pattern": "^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,4}$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.finspacedata#EnableUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspacedata#EnableUserRequest" + }, + "output": { + "target": "com.amazonaws.finspacedata#EnableUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspacedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspacedata#ConflictException" + }, + { + "target": "com.amazonaws.finspacedata#InternalServerException" + }, + { + "target": "com.amazonaws.finspacedata#LimitExceededException" + }, + { + "target": "com.amazonaws.finspacedata#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspacedata#ThrottlingException" + }, + { + "target": "com.amazonaws.finspacedata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Allows the specified user to access the FinSpace web application and API.

", + "smithy.api#http": { + "method": "POST", + "uri": "/user/{userId}/enable", + "code": 200 + } + } + }, + "com.amazonaws.finspacedata#EnableUserRequest": { + "type": "structure", + "members": { + "userId": { + "target": "com.amazonaws.finspacedata#UserId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the user account that you want to enable.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.finspacedata#ClientToken", + "traits": { + "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.finspacedata#EnableUserResponse": { + "type": "structure", + "members": { + "userId": { + "target": "com.amazonaws.finspacedata#UserId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the enabled user account.

" + } + } + } + }, + "com.amazonaws.finspacedata#ErrorCategory": { + "type": "string", + "traits": { + "smithy.api#documentation": "Changeset Error Category", + "smithy.api#enum": [ + { + "value": "VALIDATION", "name": "VALIDATION" }, { @@ -1314,6 +1795,17 @@ ] } }, + "com.amazonaws.finspacedata#FirstName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#pattern": "\\S", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.finspacedata#FormatParams": { "type": "map", "key": { @@ -1411,7 +1903,7 @@ "changeType": { "target": "com.amazonaws.finspacedata#ChangeType", "traits": { - "smithy.api#documentation": "

Type that indicates how a Changeset is applied to a Dataset.

\n
    \n
  • \n

    \n REPLACE - Changeset is considered as a replacement to all prior loaded Changesets.

    \n
    • \n
  • \n

    \n APPEND - Changeset is considered as an addition to the end of all prior loaded Changesets.

    \n
    • \n
  • \n

    \n MODIFY - Changeset is considered as a replacement to a specific prior ingested Changeset.

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

Type that indicates how a Changeset is applied to a Dataset.

\n
    \n
  • \n

    \n REPLACE – Changeset is considered as a replacement to all prior loaded Changesets.

    \n
    • \n
  • \n

    \n APPEND – Changeset is considered as an addition to the end of all prior loaded Changesets.

    \n
    • \n
  • \n

    \n MODIFY – Changeset is considered as a replacement to a specific prior ingested Changeset.

    \n
    • \n
" } }, "sourceParams": { @@ -1429,7 +1921,7 @@ "createTime": { "target": "com.amazonaws.finspacedata#TimestampEpoch", "traits": { - "smithy.api#documentation": "

The timestamp at which the Changeset was created in FinSpace. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

" + "smithy.api#documentation": "

The timestamp at which the Changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

" } }, "status": { @@ -1448,14 +1940,14 @@ "target": "com.amazonaws.finspacedata#TimestampEpoch", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

Time until which the Changeset is active. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

" + "smithy.api#documentation": "

Time until which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

" } }, "activeFromTimestamp": { "target": "com.amazonaws.finspacedata#TimestampEpoch", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

Beginning time from which the Changeset is active. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

" + "smithy.api#documentation": "

Beginning time from which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

" } }, "updatesChangesetId": { @@ -1558,7 +2050,7 @@ "target": "com.amazonaws.finspacedata#TimestampEpoch", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

Time range to use for the Dataview. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

" + "smithy.api#documentation": "

Time range to use for the Dataview. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

" } }, "errorInfo": { @@ -1570,13 +2062,13 @@ "lastModifiedTime": { "target": "com.amazonaws.finspacedata#TimestampEpoch", "traits": { - "smithy.api#documentation": "

The last time that a Dataview was modified. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

" + "smithy.api#documentation": "

The last time that a Dataview was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

" } }, "createTime": { "target": "com.amazonaws.finspacedata#TimestampEpoch", "traits": { - "smithy.api#documentation": "

The timestamp at which the Dataview was created in FinSpace. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

" + "smithy.api#documentation": "

The timestamp at which the Dataview was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

" } }, "sortColumns": { @@ -1606,7 +2098,7 @@ "status": { "target": "com.amazonaws.finspacedata#DataViewStatus", "traits": { - "smithy.api#documentation": "

The status of a Dataview creation.

\n
    \n
  • \n

    \n RUNNING - Dataview creation is running.

    \n
    • \n
  • \n

    \n STARTING - Dataview creation is starting.

    \n
    • \n
  • \n

    \n FAILED - Dataview creation has failed.

    \n
    • \n
  • \n

    \n CANCELLED - Dataview creation has been cancelled.

    \n
    • \n
  • \n

    \n TIMEOUT - Dataview creation has timed out.

    \n
    • \n
  • \n

    \n SUCCESS - Dataview creation has succeeded.

    \n
    • \n
  • \n

    \n PENDING - Dataview creation is pending.

    \n
    • \n
  • \n

    \n FAILED_CLEANUP_FAILED - Dataview creation failed and resource cleanup failed.

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

The status of a Dataview creation.

\n
    \n
  • \n

    \n RUNNING – Dataview creation is running.

    \n
    • \n
  • \n

    \n STARTING – Dataview creation is starting.

    \n
    • \n
  • \n

    \n FAILED – Dataview creation has failed.

    \n
    • \n
  • \n

    \n CANCELLED – Dataview creation has been cancelled.

    \n
    • \n
  • \n

    \n TIMEOUT – Dataview creation has timed out.

    \n
    • \n
  • \n

    \n SUCCESS – Dataview creation has succeeded.

    \n
    • \n
  • \n

    \n PENDING – Dataview creation is pending.

    \n
    • \n
  • \n

    \n FAILED_CLEANUP_FAILED – Dataview creation failed and resource cleanup failed.

    \n
    • \n
" } } }, @@ -1691,7 +2183,7 @@ "kind": { "target": "com.amazonaws.finspacedata#DatasetKind", "traits": { - "smithy.api#documentation": "

The format in which Dataset data is structured.

\n
    \n
  • \n

    \n TABULAR - Data is structured in a tabular format.

    \n
    • \n
  • \n

    \n NON_TABULAR - Data is structured in a non-tabular format.

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

The format in which Dataset data is structured.

\n
    \n
  • \n

    \n TABULAR – Data is structured in a tabular format.

    \n
    • \n
  • \n

    \n NON_TABULAR – Data is structured in a non-tabular format.

    \n
    • \n
" } }, "datasetDescription": { @@ -1703,13 +2195,13 @@ "createTime": { "target": "com.amazonaws.finspacedata#TimestampEpoch", "traits": { - "smithy.api#documentation": "

The timestamp at which the Dataset was created in FinSpace. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

" + "smithy.api#documentation": "

The timestamp at which the Dataset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

" } }, "lastModifiedTime": { "target": "com.amazonaws.finspacedata#TimestampEpoch", "traits": { - "smithy.api#documentation": "

The last time that the Dataset was modified. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

" + "smithy.api#documentation": "

The last time that the Dataset was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

" } }, "schemaDefinition": { @@ -1727,7 +2219,7 @@ "status": { "target": "com.amazonaws.finspacedata#DatasetStatus", "traits": { - "smithy.api#documentation": "

Status of the Dataset creation.

\n
    \n
  • \n

    \n PENDING - Dataset is pending creation.

    \n
    • \n
  • \n

    \n FAILED - Dataset creation has failed.

    \n
    • \n
  • \n

    \n SUCCESS - Dataset creation has succeeded.

    \n
    • \n
  • \n

    \n RUNNING - Dataset creation is running.

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

Status of the Dataset creation.

\n
    \n
  • \n

    \n PENDING – Dataset is pending creation.

    \n
    • \n
  • \n

    \n FAILED – Dataset creation has failed.

    \n
    • \n
  • \n

    \n SUCCESS – Dataset creation has succeeded.

    \n
    • \n
  • \n

    \n RUNNING – Dataset creation is running.

    \n
    • \n
" } } }, @@ -1809,6 +2301,136 @@ "smithy.api#documentation": "Response for GetProgrammaticAccessCredentials operation" } }, + "com.amazonaws.finspacedata#GetUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspacedata#GetUserRequest" + }, + "output": { + "target": "com.amazonaws.finspacedata#GetUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspacedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspacedata#InternalServerException" + }, + { + "target": "com.amazonaws.finspacedata#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspacedata#ThrottlingException" + }, + { + "target": "com.amazonaws.finspacedata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves details for a specific user.

", + "smithy.api#http": { + "method": "GET", + "uri": "/user/{userId}", + "code": 200 + } + } + }, + "com.amazonaws.finspacedata#GetUserRequest": { + "type": "structure", + "members": { + "userId": { + "target": "com.amazonaws.finspacedata#UserId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the user to get data for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.finspacedata#GetUserResponse": { + "type": "structure", + "members": { + "userId": { + "target": "com.amazonaws.finspacedata#UserId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the user account that is retrieved.

" + } + }, + "status": { + "target": "com.amazonaws.finspacedata#UserStatus", + "traits": { + "smithy.api#documentation": "

The current status of the user account.

\n
    \n
  • \n

    \n CREATING – The user account creation is in progress.

    \n
    • \n
  • \n

    \n ENABLED – The user account is created and is currently active.

    \n
    • \n
  • \n

    \n DISABLED – The user account is currently inactive.

    \n
    • \n
" + } + }, + "firstName": { + "target": "com.amazonaws.finspacedata#FirstName", + "traits": { + "smithy.api#documentation": "

The first name of the user.

" + } + }, + "lastName": { + "target": "com.amazonaws.finspacedata#LastName", + "traits": { + "smithy.api#documentation": "

The last name of the user.

" + } + }, + "emailAddress": { + "target": "com.amazonaws.finspacedata#Email", + "traits": { + "smithy.api#documentation": "

The email address that is associated with the user.

" + } + }, + "type": { + "target": "com.amazonaws.finspacedata#UserType", + "traits": { + "smithy.api#documentation": "

Indicates the type of user.

\n
    \n
  • \n

    \n SUPER_USER – A user with permission to all the functionality and data in FinSpace.

    \n
    • \n
\n
    \n
  • \n

    \n APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permissions group.

    \n
    • \n
" + } + }, + "apiAccess": { + "target": "com.amazonaws.finspacedata#ApiAccess", + "traits": { + "smithy.api#documentation": "

Indicates whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.

\n
    \n
  • \n

    \n ENABLED – The user has permissions to use the APIs.

    \n
    • \n
  • \n

    \n DISABLED – The user does not have permissions to use any APIs.

    \n
    • \n
" + } + }, + "apiAccessPrincipalArn": { + "target": "com.amazonaws.finspacedata#RoleArn", + "traits": { + "smithy.api#documentation": "

The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.

" + } + }, + "createTime": { + "target": "com.amazonaws.finspacedata#TimestampEpoch", + "traits": { + "smithy.api#documentation": "

The timestamp at which the user account was created in FinSpace. The value is determined as epoch time in milliseconds.

" + } + }, + "lastEnabledTime": { + "target": "com.amazonaws.finspacedata#TimestampEpoch", + "traits": { + "smithy.api#documentation": "

Describes the last time the user account was enabled. The value is determined as epoch time in milliseconds.

" + } + }, + "lastDisabledTime": { + "target": "com.amazonaws.finspacedata#TimestampEpoch", + "traits": { + "smithy.api#documentation": "

Describes the last time the user account was disabled. The value is determined as epoch time in milliseconds.

" + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.finspacedata#TimestampEpoch", + "traits": { + "smithy.api#documentation": "

Describes the last time the user account was updated. The value is determined as epoch time in milliseconds.

" + } + }, + "lastLoginTime": { + "target": "com.amazonaws.finspacedata#TimestampEpoch", + "traits": { + "smithy.api#documentation": "

Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.

" + } + } + } + }, "com.amazonaws.finspacedata#GetWorkingLocation": { "type": "operation", "input": { @@ -1846,7 +2468,7 @@ "locationType": { "target": "com.amazonaws.finspacedata#locationType", "traits": { - "smithy.api#documentation": "

Specify the type of the working location.

\n
    \n
  • \n

    \n SAGEMAKER - Use the Amazon S3 location as a temporary location to store data content when\n working with FinSpace Notebooks that run on SageMaker studio.

    \n
    • \n
  • \n

    \n INGESTION - Use the Amazon S3 location as a staging location to copy your\n data content and then use the location with the Changeset creation operation.

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

Specify the type of the working location.

\n
    \n
  • \n

    \n SAGEMAKER – Use the Amazon S3 location as a temporary location to store data content when\n working with FinSpace Notebooks that run on SageMaker studio.

    \n
    • \n
  • \n

    \n INGESTION – Use the Amazon S3 location as a staging location to copy your\n data content and then use the location with the Changeset creation operation.

    \n
    • \n
" } } } @@ -1924,6 +2546,17 @@ "smithy.api#httpError": 500 } }, + "com.amazonaws.finspacedata#LastName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#pattern": "\\S", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.finspacedata#LimitExceededException": { "type": "structure", "members": { @@ -2001,7 +2634,7 @@ "nextToken": { "target": "com.amazonaws.finspacedata#PaginationToken", "traits": { - "smithy.api#documentation": "

A token indicating where a results page should begin.

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

A token that indicates where a results page should begin.

", "smithy.api#httpQuery": "nextToken" } } @@ -2022,7 +2655,7 @@ "nextToken": { "target": "com.amazonaws.finspacedata#PaginationToken", "traits": { - "smithy.api#documentation": "

A token indicating where a results page should begin.

" + "smithy.api#documentation": "

A token that indicates where a results page should begin.

" } } }, @@ -2083,7 +2716,7 @@ "nextToken": { "target": "com.amazonaws.finspacedata#PaginationToken", "traits": { - "smithy.api#documentation": "

A token indicating where a results page should begin.

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

A token that indicates where a results page should begin.

", "smithy.api#httpQuery": "nextToken" } }, @@ -2106,7 +2739,7 @@ "nextToken": { "target": "com.amazonaws.finspacedata#PaginationToken", "traits": { - "smithy.api#documentation": "

A token indicating where a results page should begin.

" + "smithy.api#documentation": "

A token that indicates where a results page should begin.

" } }, "dataViews": { @@ -2162,7 +2795,7 @@ "nextToken": { "target": "com.amazonaws.finspacedata#PaginationToken", "traits": { - "smithy.api#documentation": "

A token indicating where a results page should begin.

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

A token that indicates where a results page should begin.

", "smithy.api#httpQuery": "nextToken" } }, @@ -2191,7 +2824,7 @@ "nextToken": { "target": "com.amazonaws.finspacedata#PaginationToken", "traits": { - "smithy.api#documentation": "

A token indicating where a results page should begin.

" + "smithy.api#documentation": "

A token that indicates where a results page should begin.

" } } }, @@ -2199,20 +2832,166 @@ "smithy.api#documentation": "Response for the ListDatasets operation" } }, - "com.amazonaws.finspacedata#OwnerName": { - "type": "string", - "traits": { - "smithy.api#documentation": "1 - 250 character String", - "smithy.api#length": { - "min": 1, - "max": 250 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.finspacedata#PaginationToken": { - "type": "string", - "traits": { + "com.amazonaws.finspacedata#ListPermissionGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspacedata#ListPermissionGroupsRequest" + }, + "output": { + "target": "com.amazonaws.finspacedata#ListPermissionGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspacedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspacedata#InternalServerException" + }, + { + "target": "com.amazonaws.finspacedata#ThrottlingException" + }, + { + "target": "com.amazonaws.finspacedata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all available permission groups in FinSpace.

", + "smithy.api#http": { + "method": "GET", + "uri": "/permission-group", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.finspacedata#ListPermissionGroupsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.finspacedata#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token that indicates where a results page should begin.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.finspacedata#ResultLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of results per page.

", + "smithy.api#httpQuery": "maxResults", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.finspacedata#ListPermissionGroupsResponse": { + "type": "structure", + "members": { + "permissionGroups": { + "target": "com.amazonaws.finspacedata#PermissionGroupList", + "traits": { + "smithy.api#documentation": "

A list of all the permission groups.

" + } + }, + "nextToken": { + "target": "com.amazonaws.finspacedata#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token that indicates where a results page should begin.

" + } + } + } + }, + "com.amazonaws.finspacedata#ListUsers": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspacedata#ListUsersRequest" + }, + "output": { + "target": "com.amazonaws.finspacedata#ListUsersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspacedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspacedata#InternalServerException" + }, + { + "target": "com.amazonaws.finspacedata#ThrottlingException" + }, + { + "target": "com.amazonaws.finspacedata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all available user accounts in FinSpace.

", + "smithy.api#http": { + "method": "GET", + "uri": "/user", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.finspacedata#ListUsersRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.finspacedata#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token that indicates where a results page should begin.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.finspacedata#ResultLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of results per page.

", + "smithy.api#httpQuery": "maxResults", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.finspacedata#ListUsersResponse": { + "type": "structure", + "members": { + "users": { + "target": "com.amazonaws.finspacedata#UserList", + "traits": { + "smithy.api#documentation": "

A list of all the user accounts.

" + } + }, + "nextToken": { + "target": "com.amazonaws.finspacedata#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token that indicates where a results page should begin.

" + } + } + } + }, + "com.amazonaws.finspacedata#OwnerName": { + "type": "string", + "traits": { + "smithy.api#documentation": "1 - 250 character String", + "smithy.api#length": { + "min": 1, + "max": 250 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.finspacedata#PaginationToken": { + "type": "string", + "traits": { "smithy.api#documentation": "Pagination token for list operations" } }, @@ -2225,14 +3004,97 @@ "smithy.api#documentation": "DataView Partition Column List" } }, + "com.amazonaws.finspacedata#Password": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 8, + "max": 20 + }, + "smithy.api#pattern": "\\S", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.finspacedata#PermissionGroup": { + "type": "structure", + "members": { + "permissionGroupId": { + "target": "com.amazonaws.finspacedata#PermissionGroupId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the permission group.

" + } + }, + "name": { + "target": "com.amazonaws.finspacedata#PermissionGroupName", + "traits": { + "smithy.api#documentation": "

The name of the permission group.

" + } + }, + "description": { + "target": "com.amazonaws.finspacedata#PermissionGroupDescription", + "traits": { + "smithy.api#documentation": "

A brief description for the permission group.

" + } + }, + "applicationPermissions": { + "target": "com.amazonaws.finspacedata#ApplicationPermissionList", + "traits": { + "smithy.api#documentation": "

Indicates the permissions that are granted to a specific group for accessing the FinSpace application.

\n
    \n
  • \n

    \n CreateDataset – Group members can create new datasets.

    \n
    • \n
  • \n

    \n ManageClusters – Group members can manage Apache Spark clusters from FinSpace notebooks.

    \n
    • \n
  • \n

    \n ManageUsersAndGroups – Group members can manage users and permission groups.

    \n
    • \n
  • \n

    \n ManageAttributeSets – Group members can manage attribute sets.

    \n
    • \n
  • \n

    \n ViewAuditData – Group members can view audit data.

    \n
    • \n
  • \n

    \n AccessNotebooks – Group members will have access to FinSpace notebooks.

    \n
    • \n
  • \n

    \n GetTemporaryCredentials – Group members can get temporary API credentials.

    \n
    • \n
" + } + }, + "createTime": { + "target": "com.amazonaws.finspacedata#TimestampEpoch", + "traits": { + "smithy.api#documentation": "

The timestamp at which the group was created in FinSpace. The value is determined as epoch time in milliseconds.\n

" + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.finspacedata#TimestampEpoch", + "traits": { + "smithy.api#documentation": "

Describes the last time the permission group was updated. The value is determined as epoch time in milliseconds.\n

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

The structure for a permission group.

" + } + }, + "com.amazonaws.finspacedata#PermissionGroupDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4000 + }, + "smithy.api#pattern": "\\S", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.finspacedata#PermissionGroupId": { "type": "string", "traits": { - "smithy.api#documentation": "Id of the associated PermissionGroup", "smithy.api#length": { "min": 1, "max": 26 - } + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.finspacedata#PermissionGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.finspacedata#PermissionGroup" + } + }, + "com.amazonaws.finspacedata#PermissionGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "\\S", + "smithy.api#sensitive": {} } }, "com.amazonaws.finspacedata#PermissionGroupParams": { @@ -2241,7 +3103,7 @@ "permissionGroupId": { "target": "com.amazonaws.finspacedata#PermissionGroupId", "traits": { - "smithy.api#documentation": "

The unique identifier of the PermissionGroup.

" + "smithy.api#documentation": "

The unique identifier for the PermissionGroup.

" } }, "datasetPermissions": { @@ -2266,11 +3128,88 @@ "smithy.api#pattern": "^[\\+0-9\\#\\,\\(][\\+0-9\\-\\.\\/\\(\\)\\,\\#\\s]+$" } }, + "com.amazonaws.finspacedata#ResetUserPassword": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspacedata#ResetUserPasswordRequest" + }, + "output": { + "target": "com.amazonaws.finspacedata#ResetUserPasswordResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspacedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspacedata#ConflictException" + }, + { + "target": "com.amazonaws.finspacedata#InternalServerException" + }, + { + "target": "com.amazonaws.finspacedata#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspacedata#ThrottlingException" + }, + { + "target": "com.amazonaws.finspacedata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Resets the password for a specified user ID and generates a temporary one. Only a superuser can reset password for other users. Resetting the password immediately invalidates the previous password associated with the user.

", + "smithy.api#http": { + "method": "POST", + "uri": "/user/{userId}/password", + "code": 200 + } + } + }, + "com.amazonaws.finspacedata#ResetUserPasswordRequest": { + "type": "structure", + "members": { + "userId": { + "target": "com.amazonaws.finspacedata#UserId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the user that a temporary password is requested for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.finspacedata#ClientToken", + "traits": { + "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.finspacedata#ResetUserPasswordResponse": { + "type": "structure", + "members": { + "userId": { + "target": "com.amazonaws.finspacedata#UserId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the user that a new password is generated for.

" + } + }, + "temporaryPassword": { + "target": "com.amazonaws.finspacedata#Password", + "traits": { + "smithy.api#documentation": "

A randomly generated temporary password for the requested user account. This password expires in 7 days.

" + } + } + } + }, "com.amazonaws.finspacedata#ResourceNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.finspacedata#ErrorMessage2" + }, + "reason": { + "target": "com.amazonaws.finspacedata#ErrorMessage2" } }, "traits": { @@ -2290,7 +3229,7 @@ } }, "traits": { - "smithy.api#documentation": "

Resource permission for a dataset. When you create a dataset, all the other members of the same user group inherit access to the dataset. You can only create a dataset if your user group has application permission for Create Datasets.

\n

The following is a list of valid dataset permissions that you can apply:\n \n

\n
    \n
  • \n

    \n ViewDatasetDetails\n

    \n
    • \n
  • \n

    \n ReadDatasetDetails\n

    \n
    • \n
  • \n

    \n AddDatasetData\n

    \n
    • \n
  • \n

    \n CreateSnapshot\n

    \n
    • \n
  • \n

    \n EditDatasetMetadata\n

    \n
    • \n
  • \n

    \n DeleteDataset\n

    \n
    • \n
\n

For more information on the ataset permissions, see Supported Dataset Permissions in the FinSpace User Guide.

" + "smithy.api#documentation": "

Resource permission for a dataset. When you create a dataset, all the other members of the same user group inherit access to the dataset. You can only create a dataset if your user group has application permission for Create Datasets.

\n

The following is a list of valid dataset permissions that you can apply:\n \n

\n
    \n
  • \n

    \n ViewDatasetDetails\n

    \n
    • \n
  • \n

    \n ReadDatasetDetails\n

    \n
    • \n
  • \n

    \n AddDatasetData\n

    \n
    • \n
  • \n

    \n CreateSnapshot\n

    \n
    • \n
  • \n

    \n EditDatasetMetadata\n

    \n
    • \n
  • \n

    \n DeleteDataset\n

    \n
    • \n
\n

For more information on the dataset permissions, see Supported Dataset Permissions in the FinSpace User Guide.

" } }, "com.amazonaws.finspacedata#ResourcePermissionsList": { @@ -2312,6 +3251,16 @@ } } }, + "com.amazonaws.finspacedata#RoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$" + } + }, "com.amazonaws.finspacedata#S3DestinationFormatOptions": { "type": "map", "key": { @@ -2524,7 +3473,7 @@ "formatParams": { "target": "com.amazonaws.finspacedata#FormatParams", "traits": { - "smithy.api#documentation": "

Options that define the structure of the source file(s) including the format type (formatType), header row (withHeader), data separation character (separator) and the type of compression (compression).\n

\n

\n formatType is a required attribute and can have the following values:\n

\n
    \n
  • \n

    \n PARQUET - Parquet source file format.

    \n
    • \n
  • \n

    \n CSV - CSV source file format.

    \n
    • \n
  • \n

    \n JSON - JSON source file format.

    \n
    • \n
  • \n

    \n XML - XML source file format.

    \n
    • \n
\n \n

Here is an example of how you could specify the formatParams:

\n

\n \n \"formatParams\": \n {\n \"formatType\": \"CSV\",\n \"withHeader\": \"true\",\n \"separator\": \",\",\n \"compression\":\"None\"\n } \n \n

\n

Note that if you only provide formatType as CSV, the rest of the attributes will automatically default to CSV values as following:

\n

\n \n {\n \"withHeader\": \"true\",\n \"separator\": \",\"\n }\n \n

\n

For more information about supported file formats, see Supported Data Types and File Formats in the FinSpace User Guide.

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

Options that define the structure of the source file(s) including the format type (formatType), header row (withHeader), data separation character (separator) and the type of compression (compression).\n

\n

\n formatType is a required attribute and can have the following values:\n

\n
    \n
  • \n

    \n PARQUET – Parquet source file format.

    \n
    • \n
  • \n

    \n CSV – CSV source file format.

    \n
    • \n
  • \n

    \n JSON – JSON source file format.

    \n
    • \n
  • \n

    \n XML – XML source file format.

    \n
    • \n
\n \n

Here is an example of how you could specify the formatParams:

\n

\n \n \"formatParams\": \n {\n \"formatType\": \"CSV\",\n \"withHeader\": \"true\",\n \"separator\": \",\",\n \"compression\":\"None\"\n } \n \n

\n

Note that if you only provide formatType as CSV, the rest of the attributes will automatically default to CSV values as following:

\n

\n \n {\n \"withHeader\": \"true\",\n \"separator\": \",\"\n }\n \n

\n

For more information about supported file formats, see Supported Data Types and File Formats in the FinSpace User Guide.

", "smithy.api#required": {} } } @@ -2618,7 +3567,7 @@ "kind": { "target": "com.amazonaws.finspacedata#DatasetKind", "traits": { - "smithy.api#documentation": "

The format in which the Dataset data is structured.

\n
    \n
  • \n

    \n TABULAR - Data is structured in a tabular format.

    \n
    • \n
  • \n

    \n NON_TABULAR - Data is structured in a non-tabular format.

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

The format in which the Dataset data is structured.

\n
    \n
  • \n

    \n TABULAR – Data is structured in a tabular format.

    \n
    • \n
  • \n

    \n NON_TABULAR – Data is structured in a non-tabular format.

    \n
    • \n
", "smithy.api#required": {} } }, @@ -2659,11 +3608,334 @@ "smithy.api#documentation": "The response from an UpdateDataset operation" } }, + "com.amazonaws.finspacedata#UpdatePermissionGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspacedata#UpdatePermissionGroupRequest" + }, + "output": { + "target": "com.amazonaws.finspacedata#UpdatePermissionGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspacedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspacedata#ConflictException" + }, + { + "target": "com.amazonaws.finspacedata#InternalServerException" + }, + { + "target": "com.amazonaws.finspacedata#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspacedata#ThrottlingException" + }, + { + "target": "com.amazonaws.finspacedata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the details of a permission group. You cannot modify a permissionGroupID.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/permission-group/{permissionGroupId}", + "code": 200 + } + } + }, + "com.amazonaws.finspacedata#UpdatePermissionGroupRequest": { + "type": "structure", + "members": { + "permissionGroupId": { + "target": "com.amazonaws.finspacedata#PermissionGroupId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the permission group to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.finspacedata#PermissionGroupName", + "traits": { + "smithy.api#documentation": "

The name of the permission group.

" + } + }, + "description": { + "target": "com.amazonaws.finspacedata#PermissionGroupDescription", + "traits": { + "smithy.api#documentation": "

A brief description for the permission group.

" + } + }, + "applicationPermissions": { + "target": "com.amazonaws.finspacedata#ApplicationPermissionList", + "traits": { + "smithy.api#documentation": "

The permissions that are granted to a specific group for accessing the FinSpace application.

\n
    \n
  • \n

    \n CreateDataset – Group members can create new datasets.

    \n
    • \n
  • \n

    \n ManageClusters – Group members can manage Apache Spark clusters from FinSpace notebooks.

    \n
    • \n
  • \n

    \n ManageUsersAndGroups – Group members can manage users and permission groups.

    \n
    • \n
  • \n

    \n ManageAttributeSets – Group members can manage attribute sets.

    \n
    • \n
  • \n

    \n ViewAuditData – Group members can view audit data.

    \n
    • \n
  • \n

    \n AccessNotebooks – Group members will have access to FinSpace notebooks.

    \n
    • \n
  • \n

    \n GetTemporaryCredentials – Group members can get temporary API credentials.

    \n
    • \n
" + } + }, + "clientToken": { + "target": "com.amazonaws.finspacedata#ClientToken", + "traits": { + "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.finspacedata#UpdatePermissionGroupResponse": { + "type": "structure", + "members": { + "permissionGroupId": { + "target": "com.amazonaws.finspacedata#PermissionGroupId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the updated permission group.

" + } + } + } + }, + "com.amazonaws.finspacedata#UpdateUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspacedata#UpdateUserRequest" + }, + "output": { + "target": "com.amazonaws.finspacedata#UpdateUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspacedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspacedata#ConflictException" + }, + { + "target": "com.amazonaws.finspacedata#InternalServerException" + }, + { + "target": "com.amazonaws.finspacedata#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspacedata#ThrottlingException" + }, + { + "target": "com.amazonaws.finspacedata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the details of the specified user account. You cannot update the userId for a user.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/user/{userId}", + "code": 200 + } + } + }, + "com.amazonaws.finspacedata#UpdateUserRequest": { + "type": "structure", + "members": { + "userId": { + "target": "com.amazonaws.finspacedata#UserId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the user account to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.finspacedata#UserType", + "traits": { + "smithy.api#documentation": "

The option to indicate the type of user.

\n
    \n
  • \n

    \n SUPER_USER– A user with permission to all the functionality and data in FinSpace.

    \n
    • \n
  • \n

    \n APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permissions group.

    \n
    • \n
" + } + }, + "firstName": { + "target": "com.amazonaws.finspacedata#FirstName", + "traits": { + "smithy.api#documentation": "

The first name of the user.

" + } + }, + "lastName": { + "target": "com.amazonaws.finspacedata#LastName", + "traits": { + "smithy.api#documentation": "

The last name of the user.

" + } + }, + "apiAccess": { + "target": "com.amazonaws.finspacedata#ApiAccess", + "traits": { + "smithy.api#documentation": "

The option to indicate whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.

\n
    \n
  • \n

    \n ENABLED – The user has permissions to use the APIs.

    \n
    • \n
  • \n

    \n DISABLED – The user does not have permissions to use any APIs.

    \n
    • \n
" + } + }, + "apiAccessPrincipalArn": { + "target": "com.amazonaws.finspacedata#RoleArn", + "traits": { + "smithy.api#documentation": "

The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.

" + } + }, + "clientToken": { + "target": "com.amazonaws.finspacedata#ClientToken", + "traits": { + "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.finspacedata#UpdateUserResponse": { + "type": "structure", + "members": { + "userId": { + "target": "com.amazonaws.finspacedata#UserId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the updated user account.

" + } + } + } + }, + "com.amazonaws.finspacedata#User": { + "type": "structure", + "members": { + "userId": { + "target": "com.amazonaws.finspacedata#UserId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the user.

" + } + }, + "status": { + "target": "com.amazonaws.finspacedata#UserStatus", + "traits": { + "smithy.api#documentation": "

The current status of the user account.

\n
    \n
  • \n

    \n CREATING – The user account creation is in progress.

    \n
    • \n
  • \n

    \n ENABLED – The user account is created and is currently active.

    \n
    • \n
  • \n

    \n DISABLED – The user account is currently inactive.

    \n
    • \n
" + } + }, + "firstName": { + "target": "com.amazonaws.finspacedata#FirstName", + "traits": { + "smithy.api#documentation": "

The first name of the user.

" + } + }, + "lastName": { + "target": "com.amazonaws.finspacedata#LastName", + "traits": { + "smithy.api#documentation": "

The last name of the user.

" + } + }, + "emailAddress": { + "target": "com.amazonaws.finspacedata#Email", + "traits": { + "smithy.api#documentation": "

The email address of the user. The email address serves as a uniquer identifier for each user and cannot be changed after it's created.

" + } + }, + "type": { + "target": "com.amazonaws.finspacedata#UserType", + "traits": { + "smithy.api#documentation": "

Indicates the type of user.

\n
    \n
  • \n

    \n SUPER_USER – A user with permission to all the functionality and data in FinSpace.

    \n
    • \n
  • \n

    \n APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permissions group.

    \n
    • \n
" + } + }, + "apiAccess": { + "target": "com.amazonaws.finspacedata#ApiAccess", + "traits": { + "smithy.api#documentation": "

Indicates whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.

\n
    \n
  • \n

    \n ENABLED – The user has permissions to use the APIs.

    \n
    • \n
  • \n

    \n DISABLED – The user does not have permissions to use any APIs.

    \n
    • \n
" + } + }, + "apiAccessPrincipalArn": { + "target": "com.amazonaws.finspacedata#RoleArn", + "traits": { + "smithy.api#documentation": "

The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.

" + } + }, + "createTime": { + "target": "com.amazonaws.finspacedata#TimestampEpoch", + "traits": { + "smithy.api#documentation": "

The timestamp at which the user account was created in FinSpace. The value is determined as epoch time in milliseconds.

" + } + }, + "lastEnabledTime": { + "target": "com.amazonaws.finspacedata#TimestampEpoch", + "traits": { + "smithy.api#documentation": "

Describes the last time the user account was enabled. The value is determined as epoch time in milliseconds.\n

" + } + }, + "lastDisabledTime": { + "target": "com.amazonaws.finspacedata#TimestampEpoch", + "traits": { + "smithy.api#documentation": "

Describes the last time the user account was disabled. The value is determined as epoch time in milliseconds.

" + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.finspacedata#TimestampEpoch", + "traits": { + "smithy.api#documentation": "

Describes the last time the user account was updated. The value is determined as epoch time in milliseconds.\n

" + } + }, + "lastLoginTime": { + "target": "com.amazonaws.finspacedata#TimestampEpoch", + "traits": { + "smithy.api#documentation": "

Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.\n

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

The details of the user account.

" + } + }, + "com.amazonaws.finspacedata#UserId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 26 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.finspacedata#UserList": { + "type": "list", + "member": { + "target": "com.amazonaws.finspacedata#User" + } + }, + "com.amazonaws.finspacedata#UserStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATING", + "name": "CREATING" + }, + { + "value": "ENABLED", + "name": "ENABLED" + }, + { + "value": "DISABLED", + "name": "DISABLED" + } + ] + } + }, + "com.amazonaws.finspacedata#UserType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SUPER_USER", + "name": "SUPER_USER" + }, + { + "value": "APP_USER", + "name": "APP_USER" + } + ] + } + }, "com.amazonaws.finspacedata#ValidationException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.finspacedata#ErrorMessage2" + }, + "reason": { + "target": "com.amazonaws.finspacedata#ErrorMessage2" } }, "traits": { diff --git a/aws/sdk/aws-models/fis.json b/aws/sdk/aws-models/fis.json index b387b75049..702190d626 100644 --- a/aws/sdk/aws-models/fis.json +++ b/aws/sdk/aws-models/fis.json @@ -221,6 +221,16 @@ "smithy.api#pattern": "^[\\S]+$" } }, + "com.amazonaws.fis#CloudWatchLogGroupArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, "com.amazonaws.fis#ConflictException": { "type": "structure", "members": { @@ -317,6 +327,33 @@ "target": "com.amazonaws.fis#CreateExperimentTemplateActionInput" } }, + "com.amazonaws.fis#CreateExperimentTemplateLogConfigurationInput": { + "type": "structure", + "members": { + "cloudWatchLogsConfiguration": { + "target": "com.amazonaws.fis#ExperimentTemplateCloudWatchLogsLogConfigurationInput", + "traits": { + "smithy.api#documentation": "

The configuration for experiment logging to Amazon CloudWatch Logs.

" + } + }, + "s3Configuration": { + "target": "com.amazonaws.fis#ExperimentTemplateS3LogConfigurationInput", + "traits": { + "smithy.api#documentation": "

The configuration for experiment logging to Amazon S3.

" + } + }, + "logSchemaVersion": { + "target": "com.amazonaws.fis#LogSchemaVersion", + "traits": { + "smithy.api#documentation": "

The schema version.

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

Specifies the configuration for experiment logging.

" + } + }, "com.amazonaws.fis#CreateExperimentTemplateRequest": { "type": "structure", "members": { @@ -367,6 +404,12 @@ "traits": { "smithy.api#documentation": "

The tags to apply to the experiment template.

" } + }, + "logConfiguration": { + "target": "com.amazonaws.fis#CreateExperimentTemplateLogConfigurationInput", + "traits": { + "smithy.api#documentation": "

The configuration for experiment logging.

" + } } } }, @@ -593,6 +636,12 @@ "traits": { "smithy.api#documentation": "

The tags for the experiment.

" } + }, + "logConfiguration": { + "target": "com.amazonaws.fis#ExperimentLogConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for experiment logging.

" + } } }, "traits": { @@ -823,6 +872,20 @@ "smithy.api#pattern": "^[\\S]+$" } }, + "com.amazonaws.fis#ExperimentCloudWatchLogsLogConfiguration": { + "type": "structure", + "members": { + "logGroupArn": { + "target": "com.amazonaws.fis#CloudWatchLogGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.

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

Describes the configuration for experiment logging to Amazon CloudWatch Logs.

" + } + }, "com.amazonaws.fis#ExperimentEndTime": { "type": "timestamp" }, @@ -836,6 +899,52 @@ "smithy.api#pattern": "^[\\S]+$" } }, + "com.amazonaws.fis#ExperimentLogConfiguration": { + "type": "structure", + "members": { + "cloudWatchLogsConfiguration": { + "target": "com.amazonaws.fis#ExperimentCloudWatchLogsLogConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for experiment logging to Amazon CloudWatch Logs.

" + } + }, + "s3Configuration": { + "target": "com.amazonaws.fis#ExperimentS3LogConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for experiment logging to Amazon S3.

" + } + }, + "logSchemaVersion": { + "target": "com.amazonaws.fis#LogSchemaVersion", + "traits": { + "smithy.api#documentation": "

The schema version.

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

Describes the configuration for experiment logging.

" + } + }, + "com.amazonaws.fis#ExperimentS3LogConfiguration": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.fis#S3BucketName", + "traits": { + "smithy.api#documentation": "

The name of the destination bucket.

" + } + }, + "prefix": { + "target": "com.amazonaws.fis#S3ObjectKey", + "traits": { + "smithy.api#documentation": "

The bucket prefix.

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

Describes the configuration for experiment logging to Amazon S3.

" + } + }, "com.amazonaws.fis#ExperimentStartTime": { "type": "timestamp" }, @@ -1183,6 +1292,12 @@ "traits": { "smithy.api#documentation": "

The tags for the experiment template.

" } + }, + "logConfiguration": { + "target": "com.amazonaws.fis#ExperimentTemplateLogConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for experiment logging.

" + } } }, "traits": { @@ -1320,6 +1435,35 @@ "smithy.api#pattern": "^[\\S]+$" } }, + "com.amazonaws.fis#ExperimentTemplateCloudWatchLogsLogConfiguration": { + "type": "structure", + "members": { + "logGroupArn": { + "target": "com.amazonaws.fis#CloudWatchLogGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.

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

Describes the configuration for experiment logging to Amazon CloudWatch Logs.

" + } + }, + "com.amazonaws.fis#ExperimentTemplateCloudWatchLogsLogConfigurationInput": { + "type": "structure", + "members": { + "logGroupArn": { + "target": "com.amazonaws.fis#CloudWatchLogGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.

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

Specifies the configuration for experiment logging to Amazon CloudWatch Logs.

" + } + }, "com.amazonaws.fis#ExperimentTemplateDescription": { "type": "string", "traits": { @@ -1340,6 +1484,73 @@ "smithy.api#pattern": "^[\\S]+$" } }, + "com.amazonaws.fis#ExperimentTemplateLogConfiguration": { + "type": "structure", + "members": { + "cloudWatchLogsConfiguration": { + "target": "com.amazonaws.fis#ExperimentTemplateCloudWatchLogsLogConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for experiment logging to Amazon CloudWatch Logs.

" + } + }, + "s3Configuration": { + "target": "com.amazonaws.fis#ExperimentTemplateS3LogConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for experiment logging to Amazon S3.

" + } + }, + "logSchemaVersion": { + "target": "com.amazonaws.fis#LogSchemaVersion", + "traits": { + "smithy.api#documentation": "

The schema version.

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

Describes the configuration for experiment logging.

" + } + }, + "com.amazonaws.fis#ExperimentTemplateS3LogConfiguration": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.fis#S3BucketName", + "traits": { + "smithy.api#documentation": "

The name of the destination bucket.

" + } + }, + "prefix": { + "target": "com.amazonaws.fis#S3ObjectKey", + "traits": { + "smithy.api#documentation": "

The bucket prefix.

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

Describes the configuration for experiment logging to Amazon S3.

" + } + }, + "com.amazonaws.fis#ExperimentTemplateS3LogConfigurationInput": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.fis#S3BucketName", + "traits": { + "smithy.api#documentation": "

The name of the destination bucket.

", + "smithy.api#required": {} + } + }, + "prefix": { + "target": "com.amazonaws.fis#S3ObjectKey", + "traits": { + "smithy.api#documentation": "

The bucket prefix.

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

Specifies the configuration for experiment logging to Amazon S3.

" + } + }, "com.amazonaws.fis#ExperimentTemplateStopCondition": { "type": "structure", "members": { @@ -2193,6 +2404,12 @@ } } }, + "com.amazonaws.fis#LogSchemaVersion": { + "type": "integer", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.fis#NextToken": { "type": "string", "traits": { @@ -2252,6 +2469,26 @@ "smithy.api#pattern": "^[\\S]+$" } }, + "com.amazonaws.fis#S3BucketName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.fis#S3ObjectKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[\\s\\S]+$" + } + }, "com.amazonaws.fis#ServiceQuotaExceededException": { "type": "structure", "members": { @@ -2729,6 +2966,32 @@ "target": "com.amazonaws.fis#UpdateExperimentTemplateActionInputItem" } }, + "com.amazonaws.fis#UpdateExperimentTemplateLogConfigurationInput": { + "type": "structure", + "members": { + "cloudWatchLogsConfiguration": { + "target": "com.amazonaws.fis#ExperimentTemplateCloudWatchLogsLogConfigurationInput", + "traits": { + "smithy.api#documentation": "

The configuration for experiment logging to Amazon CloudWatch Logs.

" + } + }, + "s3Configuration": { + "target": "com.amazonaws.fis#ExperimentTemplateS3LogConfigurationInput", + "traits": { + "smithy.api#documentation": "

The configuration for experiment logging to Amazon S3.

" + } + }, + "logSchemaVersion": { + "target": "com.amazonaws.fis#LogSchemaVersion", + "traits": { + "smithy.api#documentation": "

The schema version.

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

Specifies the configuration for experiment logging.

" + } + }, "com.amazonaws.fis#UpdateExperimentTemplateRequest": { "type": "structure", "members": { @@ -2769,6 +3032,12 @@ "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf.

" } + }, + "logConfiguration": { + "target": "com.amazonaws.fis#UpdateExperimentTemplateLogConfigurationInput", + "traits": { + "smithy.api#documentation": "

The configuration for experiment logging.

" + } } } }, diff --git a/aws/sdk/aws-models/fms.json b/aws/sdk/aws-models/fms.json index 1ae607a8ff..b78abbbb2c 100644 --- a/aws/sdk/aws-models/fms.json +++ b/aws/sdk/aws-models/fms.json @@ -53,7 +53,7 @@ "name": "fms" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

This is the Firewall Manager API Reference. This guide is for\n developers who need detailed information about the Firewall Manager API actions, data\n types, and errors. For detailed information about Firewall Manager features, see the\n Firewall Manager Developer Guide.

\n

Some API actions require explicit resource permissions. For information, see the developer guide topic \n Firewall Manager required permissions for API actions.\n

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

This is the Firewall Manager API Reference. This guide is for\n developers who need detailed information about the Firewall Manager API actions, data types, and\n errors. For detailed information about Firewall Manager features, see the Firewall Manager\n Developer Guide.

\n

Some API actions require explicit resource permissions. For information, see the\n developer guide topic Firewall Manager required permissions\n for API actions.

", "smithy.api#title": "Firewall Management Service" }, "version": "2018-01-01", @@ -198,7 +198,7 @@ "Protocol": { "target": "com.amazonaws.fms#Protocol", "traits": { - "smithy.api#documentation": "

The IP protocol name or number. The name can be one of tcp, udp, or icmp. For information on possible numbers, see Protocol Numbers.

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

The IP protocol name or number. The name can be one of tcp,\n udp, or icmp. For information on possible numbers, see Protocol\n Numbers.

", "smithy.api#required": {} } }, @@ -239,7 +239,7 @@ "ListUpdateToken": { "target": "com.amazonaws.fms#UpdateToken", "traits": { - "smithy.api#documentation": "

A unique identifier for each update to the list. When you update \n the list, the update token must match the token of the current version of the application list. \n You can retrieve the update token by getting the list.

" + "smithy.api#documentation": "

A unique identifier for each update to the list. When you update the list, the update\n token must match the token of the current version of the application list. You can retrieve\n the update token by getting the list.

" } }, "CreateTime": { @@ -264,7 +264,7 @@ "PreviousAppsList": { "target": "com.amazonaws.fms#PreviousAppsList", "traits": { - "smithy.api#documentation": "

A map of previous version numbers to their corresponding App object arrays.

" + "smithy.api#documentation": "

A map of previous version numbers to their corresponding App object\n arrays.

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

Sets the Firewall Manager administrator account. The account must be\n a member of the organization in Organizations whose resources you want to protect. \n Firewall Manager sets the permissions that allow the account to administer your Firewall Manager policies.

\n

The account that you associate with Firewall Manager is called the Firewall Manager administrator account.

" + "smithy.api#documentation": "

Sets the Firewall Manager administrator account. The account must be a member of the\n organization in Organizations whose resources you want to protect. Firewall Manager sets the\n permissions that allow the account to administer your Firewall Manager policies.

\n

The account that you associate with Firewall Manager is called the Firewall Manager administrator\n account.

" } }, "com.amazonaws.fms#AssociateAdminAccountRequest": { @@ -342,7 +342,7 @@ "AdminAccount": { "target": "com.amazonaws.fms#AWSAccountId", "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID to associate with Firewall Manager as the Firewall Manager\n administrator account. This must be an Organizations member account.\n For more information about Organizations, see \n Managing the Amazon Web Services Accounts in Your Organization.

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

The Amazon Web Services account ID to associate with Firewall Manager as the Firewall Manager administrator account.\n This must be an Organizations member account. For more information about Organizations, see Managing the Amazon Web Services Accounts in Your Organization.

", "smithy.api#required": {} } } @@ -380,7 +380,7 @@ "ViolatingSecurityGroups": { "target": "com.amazonaws.fms#ResourceIdList", "traits": { - "smithy.api#documentation": "

List of security groups that violate the rules specified in the primary security group of the Firewall Manager policy.

" + "smithy.api#documentation": "

List of security groups that violate the rules specified in the primary security group\n of the Firewall Manager policy.

" } } }, @@ -412,7 +412,7 @@ "PartialMatches": { "target": "com.amazonaws.fms#PartialMatches", "traits": { - "smithy.api#documentation": "

List of rules specified in the security group of the Firewall Manager policy that partially match the ViolationTarget rule.

" + "smithy.api#documentation": "

List of rules specified in the security group of the Firewall Manager policy that partially\n match the ViolationTarget rule.

" } }, "PossibleSecurityGroupRemediationActions": { @@ -423,7 +423,7 @@ } }, "traits": { - "smithy.api#documentation": "

Violation detail for the rule violation in a security group when compared to the primary security group of the Firewall Manager policy.

" + "smithy.api#documentation": "

Violation detail for the rule violation in a security group when compared to the primary\n security group of the Firewall Manager policy.

" } }, "com.amazonaws.fms#BasicInteger": { @@ -466,7 +466,13 @@ "ResourceType": { "target": "com.amazonaws.fms#ResourceType", "traits": { - "smithy.api#documentation": "

The resource type. This is in the format shown in the Amazon Web Services Resource Types Reference. For example:\n AWS::ElasticLoadBalancingV2::LoadBalancer, \n AWS::CloudFront::Distribution, or\n AWS::NetworkFirewall::FirewallPolicy.

" + "smithy.api#documentation": "

The resource type. This is in the format shown in the Amazon Web Services\n Resource Types Reference. For example:\n AWS::ElasticLoadBalancingV2::LoadBalancer,\n AWS::CloudFront::Distribution, or\n AWS::NetworkFirewall::FirewallPolicy.

" + } + }, + "Metadata": { + "target": "com.amazonaws.fms#ComplianceViolatorMetadata", + "traits": { + "smithy.api#documentation": "

Metadata about the resource that doesn't comply with the policy scope.

" } } }, @@ -474,6 +480,15 @@ "smithy.api#documentation": "

Details of the resource that is not protected by the policy.

" } }, + "com.amazonaws.fms#ComplianceViolatorMetadata": { + "type": "map", + "key": { + "target": "com.amazonaws.fms#LengthBoundedString" + }, + "value": { + "target": "com.amazonaws.fms#LengthBoundedString" + } + }, "com.amazonaws.fms#ComplianceViolators": { "type": "list", "member": { @@ -546,7 +561,7 @@ "ListId": { "target": "com.amazonaws.fms#ListId", "traits": { - "smithy.api#documentation": "

The ID of the applications list that you want to delete. You can retrieve this ID from \n PutAppsList, ListAppsLists, and GetAppsList.

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

The ID of the applications list that you want to delete. You can retrieve this ID from\n PutAppsList, ListAppsLists, and\n GetAppsList.

", "smithy.api#required": {} } } @@ -569,7 +584,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an Firewall Manager association with the IAM role and the Amazon Simple\n Notification Service (SNS) topic that is used to record Firewall Manager SNS logs.

" + "smithy.api#documentation": "

Deletes an Firewall Manager association with the IAM role and the Amazon Simple Notification\n Service (SNS) topic that is used to record Firewall Manager SNS logs.

" } }, "com.amazonaws.fms#DeleteNotificationChannelRequest": { @@ -608,14 +623,14 @@ "PolicyId": { "target": "com.amazonaws.fms#PolicyId", "traits": { - "smithy.api#documentation": "

The ID of the policy that you want to delete. You can retrieve this ID from \n PutPolicy and ListPolicies.

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

The ID of the policy that you want to delete. You can retrieve this ID from\n PutPolicy and ListPolicies.

", "smithy.api#required": {} } }, "DeleteAllPolicyResources": { "target": "com.amazonaws.fms#Boolean", "traits": { - "smithy.api#documentation": "

If True, the request performs cleanup according to the policy type.

\n

For WAF and Shield Advanced policies, the cleanup does the following:

\n
    \n
  • \n

    Deletes rule groups created by Firewall Manager

    \n
    • \n
  • \n

    Removes web ACLs from in-scope resources

    \n
    • \n
  • \n

    Deletes web ACLs that contain no rules or rule groups

    \n
    • \n
\n

For security group policies, the cleanup does the following for each security group in\n the policy:

\n
    \n
  • \n

    Disassociates the security group from in-scope resources

    \n
    • \n
  • \n

    Deletes the security group if it was created through Firewall Manager and if it's\n no longer associated with any resources through another policy

    \n
    • \n
\n

After the cleanup, in-scope resources are no longer protected by web ACLs in this policy.\n Protection of out-of-scope resources remains unchanged. Scope is determined by tags that you\n create and accounts that you associate with the policy. When creating the policy, if you\n specify that only resources in specific accounts or with specific tags are in scope of the\n policy, those accounts and resources are handled by the policy. All others are out of scope.\n If you don't specify tags or accounts, all resources are in scope.

" + "smithy.api#documentation": "

If True, the request performs cleanup according to the policy type.

\n

For WAF and Shield Advanced policies, the cleanup does the following:

\n
    \n
  • \n

    Deletes rule groups created by Firewall Manager

    \n
    • \n
  • \n

    Removes web ACLs from in-scope resources

    \n
    • \n
  • \n

    Deletes web ACLs that contain no rules or rule groups

    \n
    • \n
\n

For security group policies, the cleanup does the following for each security group\n in the policy:

\n
    \n
  • \n

    Disassociates the security group from in-scope resources

    \n
    • \n
  • \n

    Deletes the security group if it was created through Firewall Manager and if it's no\n longer associated with any resources through another policy

    \n
    • \n
\n

After the cleanup, in-scope resources are no longer protected by web ACLs in this\n policy. Protection of out-of-scope resources remains unchanged. Scope is determined by tags\n that you create and accounts that you associate with the policy. When creating the policy,\n if you specify that only resources in specific accounts or with specific tags are in scope\n of the policy, those accounts and resources are handled by the policy. All others are out\n of scope. If you don't specify tags or accounts, all resources are in scope.

" } } } @@ -646,7 +661,7 @@ "ListId": { "target": "com.amazonaws.fms#ListId", "traits": { - "smithy.api#documentation": "

The ID of the protocols list that you want to delete. You can retrieve this ID from \n PutProtocolsList, ListProtocolsLists, and GetProtocolsLost.

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

The ID of the protocols list that you want to delete. You can retrieve this ID from\n PutProtocolsList, ListProtocolsLists, and\n GetProtocolsLost.

", "smithy.api#required": {} } } @@ -721,7 +736,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disassociates the account that has been set as the Firewall Manager administrator\n account. To set a different account as the administrator account, you must submit an\n AssociateAdminAccount request.

" + "smithy.api#documentation": "

Disassociates the account that has been set as the Firewall Manager administrator account. To\n set a different account as the administrator account, you must submit an\n AssociateAdminAccount request.

" } }, "com.amazonaws.fms#DisassociateAdminAccountRequest": { @@ -745,7 +760,7 @@ } }, "traits": { - "smithy.api#documentation": "

A DNS Firewall rule group that Firewall Manager \n tried to associate with a VPC is already associated with the VPC and can't be associated again.

" + "smithy.api#documentation": "

A DNS Firewall rule group that Firewall Manager tried to associate with a VPC is already associated\n with the VPC and can't be associated again.

" } }, "com.amazonaws.fms#DnsRuleGroupLimitExceededViolation": { @@ -766,12 +781,12 @@ "NumberOfRuleGroupsAlreadyAssociated": { "target": "com.amazonaws.fms#BasicInteger", "traits": { - "smithy.api#documentation": "

The number of rule groups currently associated with the VPC.

" + "smithy.api#documentation": "

The number of rule groups currently associated with the VPC.

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

The VPC that Firewall Manager was applying a DNS Fireall policy to reached the limit for associated DNS Firewall rule groups. Firewall Manager tried to associate another rule group with the VPC and failed due to the limit.

" + "smithy.api#documentation": "

The VPC that Firewall Manager was applying a DNS Fireall policy to reached the limit for associated\n DNS Firewall rule groups. Firewall Manager tried to associate another rule group with the VPC and\n failed due to the limit.

" } }, "com.amazonaws.fms#DnsRuleGroupPriorities": { @@ -801,7 +816,7 @@ "ViolationTargetDescription": { "target": "com.amazonaws.fms#LengthBoundedString", "traits": { - "smithy.api#documentation": "

A description of the violation that specifies the VPC and the rule group that's already associated with it.

" + "smithy.api#documentation": "

A description of the violation that specifies the VPC and the rule group that's already\n associated with it.

" } }, "ConflictingPriority": { @@ -813,18 +828,18 @@ "ConflictingPolicyId": { "target": "com.amazonaws.fms#PolicyId", "traits": { - "smithy.api#documentation": "

The ID of the Firewall Manager DNS Firewall policy that was already applied to the VPC. \n This policy contains the rule group that's already associated with the VPC.

" + "smithy.api#documentation": "

The ID of the Firewall Manager DNS Firewall policy that was already applied to the VPC. This policy\n contains the rule group that's already associated with the VPC.

" } }, "UnavailablePriorities": { "target": "com.amazonaws.fms#DnsRuleGroupPriorities", "traits": { - "smithy.api#documentation": "

The priorities of rule groups that are already associated with the VPC. To retry your operation, \n choose priority settings that aren't in this list for the rule groups in your new DNS Firewall policy.

" + "smithy.api#documentation": "

The priorities of rule groups that are already associated with the VPC. To retry your\n operation, choose priority settings that aren't in this list for the rule groups in your\n new DNS Firewall policy.

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

A rule group that Firewall Manager \n tried to associate with a VPC has the same priority as a rule group that's already associated.

" + "smithy.api#documentation": "

A rule group that Firewall Manager tried to associate with a VPC has the same priority as a rule\n group that's already associated.

" } }, "com.amazonaws.fms#EC2AssociateRouteTableAction": { @@ -833,7 +848,7 @@ "Description": { "target": "com.amazonaws.fms#LengthBoundedString", "traits": { - "smithy.api#documentation": "

A description of the EC2 route table that is associated with the remediation action.

" + "smithy.api#documentation": "

A description of the EC2 route table that is associated with the remediation\n action.

" } }, "RouteTableId": { @@ -846,18 +861,18 @@ "SubnetId": { "target": "com.amazonaws.fms#ActionTarget", "traits": { - "smithy.api#documentation": "

The ID of the subnet for the EC2 route table that is associated with the remediation action.

" + "smithy.api#documentation": "

The ID of the subnet for the EC2 route table that is associated with the remediation\n action.

" } }, "GatewayId": { "target": "com.amazonaws.fms#ActionTarget", "traits": { - "smithy.api#documentation": "

The ID of the gateway to be used with the EC2 route table that is associated with the remediation action.

" + "smithy.api#documentation": "

The ID of the gateway to be used with the EC2 route table that is associated with the\n remediation action.

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

The action of associating an EC2 resource, such as a subnet or internet gateway, with a route table.

" + "smithy.api#documentation": "

The action of associating an EC2 resource, such as a subnet or internet gateway, with a\n route table.

" } }, "com.amazonaws.fms#EC2CopyRouteTableAction": { @@ -866,20 +881,20 @@ "Description": { "target": "com.amazonaws.fms#LengthBoundedString", "traits": { - "smithy.api#documentation": "

A description of the copied EC2 route table that is associated with the remediation action.

" + "smithy.api#documentation": "

A description of the copied EC2 route table that is associated with the remediation\n action.

" } }, "VpcId": { "target": "com.amazonaws.fms#ActionTarget", "traits": { - "smithy.api#documentation": "

The VPC ID of the copied EC2 route table that is associated with the remediation action.

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

The VPC ID of the copied EC2 route table that is associated with the remediation\n action.

", "smithy.api#required": {} } }, "RouteTableId": { "target": "com.amazonaws.fms#ActionTarget", "traits": { - "smithy.api#documentation": "

The ID of the copied EC2 route table that is associated with the remediation action.

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

The ID of the copied EC2 route table that is associated with the remediation\n action.

", "smithy.api#required": {} } } @@ -918,13 +933,13 @@ "VpcEndpointId": { "target": "com.amazonaws.fms#ActionTarget", "traits": { - "smithy.api#documentation": "

Information about the ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.

" + "smithy.api#documentation": "

Information about the ID of a VPC endpoint. Supported for Gateway Load Balancer\n endpoints only.

" } }, "GatewayId": { "target": "com.amazonaws.fms#ActionTarget", "traits": { - "smithy.api#documentation": "

Information about the ID of an internet gateway or virtual private gateway attached to your VPC.

" + "smithy.api#documentation": "

Information about the ID of an internet gateway or virtual private gateway attached to\n your VPC.

" } }, "RouteTableId": { @@ -972,7 +987,7 @@ "DestinationCidrBlock": { "target": "com.amazonaws.fms#CIDR", "traits": { - "smithy.api#documentation": "

Information about the IPv4 CIDR range for the route. The value you specify must match the CIDR for the route exactly.

" + "smithy.api#documentation": "

Information about the IPv4 CIDR range for the route. The value you specify must match\n the CIDR for the route exactly.

" } }, "DestinationPrefixListId": { @@ -984,7 +999,7 @@ "DestinationIpv6CidrBlock": { "target": "com.amazonaws.fms#CIDR", "traits": { - "smithy.api#documentation": "

Information about the IPv6 CIDR range for the route. The value you specify must match the CIDR for the route exactly.

" + "smithy.api#documentation": "

Information about the IPv6 CIDR range for the route. The value you specify must match\n the CIDR for the route exactly.

" } }, "RouteTableId": { @@ -1011,7 +1026,7 @@ "DestinationCidrBlock": { "target": "com.amazonaws.fms#CIDR", "traits": { - "smithy.api#documentation": "

Information about the IPv4 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table.

" + "smithy.api#documentation": "

Information about the IPv4 CIDR address block used for the destination match. The value\n that you provide must match the CIDR of an existing route in the table.

" } }, "DestinationPrefixListId": { @@ -1023,7 +1038,7 @@ "DestinationIpv6CidrBlock": { "target": "com.amazonaws.fms#CIDR", "traits": { - "smithy.api#documentation": "

Information about the IPv6 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table.

" + "smithy.api#documentation": "

Information about the IPv6 CIDR address block used for the destination match. The value\n that you provide must match the CIDR of an existing route in the table.

" } }, "GatewayId": { @@ -1087,18 +1102,18 @@ "ViolatorCount": { "target": "com.amazonaws.fms#ResourceCount", "traits": { - "smithy.api#documentation": "

The number of resources that are noncompliant with the specified policy. For WAF and\n Shield Advanced policies, a resource is considered noncompliant if it is not associated with\n the policy. For security group policies, a resource is considered noncompliant if it doesn't\n comply with the rules of the policy and remediation is disabled or not possible.

" + "smithy.api#documentation": "

The number of resources that are noncompliant with the specified policy. For WAF\n and Shield Advanced policies, a resource is considered noncompliant if it is not associated\n with the policy. For security group policies, a resource is considered noncompliant if it\n doesn't comply with the rules of the policy and remediation is disabled or not\n possible.

" } }, "EvaluationLimitExceeded": { "target": "com.amazonaws.fms#Boolean", "traits": { - "smithy.api#documentation": "

Indicates that over 100 resources are noncompliant with the Firewall Manager\n policy.

" + "smithy.api#documentation": "

Indicates that over 100 resources are noncompliant with the Firewall Manager policy.

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

Describes the compliance status for the account. An account is considered noncompliant if\n it includes resources that are not protected by the specified policy or that don't comply with\n the policy.

" + "smithy.api#documentation": "

Describes the compliance status for the account. An account is considered noncompliant\n if it includes resources that are not protected by the specified policy or that don't\n comply with the policy.

" } }, "com.amazonaws.fms#EvaluationResults": { @@ -1157,6 +1172,75 @@ "target": "com.amazonaws.fms#ExpectedRoute" } }, + "com.amazonaws.fms#FMSPolicyUpdateFirewallCreationConfigAction": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.fms#LengthBoundedString", + "traits": { + "smithy.api#documentation": "

Describes the remedial action.

" + } + }, + "FirewallCreationConfig": { + "target": "com.amazonaws.fms#ManagedServiceData", + "traits": { + "smithy.api#documentation": "

A FirewallCreationConfig that you can copy into your current policy's\n SecurityServiceData in order to remedy scope violations.

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

Contains information about the actions that you can take to remediate scope violations\n caused by your policy's FirewallCreationConfig.\n FirewallCreationConfig is an optional configuration that you can use to\n choose which Availability Zones Firewall Manager creates Network Firewall endpoints in.

" + } + }, + "com.amazonaws.fms#FirewallDeploymentModel": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CENTRALIZED", + "name": "CENTRALIZED" + } + ] + } + }, + "com.amazonaws.fms#FirewallSubnetIsOutOfScopeViolation": { + "type": "structure", + "members": { + "FirewallSubnetId": { + "target": "com.amazonaws.fms#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the firewall subnet that violates the policy scope.

" + } + }, + "VpcId": { + "target": "com.amazonaws.fms#ResourceId", + "traits": { + "smithy.api#documentation": "

The VPC ID of the firewall subnet that violates the policy scope.

" + } + }, + "SubnetAvailabilityZone": { + "target": "com.amazonaws.fms#LengthBoundedString", + "traits": { + "smithy.api#documentation": "

The Availability Zone of the firewall subnet that violates the policy scope.

" + } + }, + "SubnetAvailabilityZoneId": { + "target": "com.amazonaws.fms#LengthBoundedString", + "traits": { + "smithy.api#documentation": "

The Availability Zone ID of the firewall subnet that violates the policy scope.

" + } + }, + "VpcEndpointId": { + "target": "com.amazonaws.fms#ResourceId", + "traits": { + "smithy.api#documentation": "

The VPC endpoint ID of the firewall subnet that violates the policy scope.

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

Contains details about the firewall subnet that violates the policy scope.

" + } + }, "com.amazonaws.fms#GetAdminAccount": { "type": "operation", "input": { @@ -1177,7 +1261,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the Organizations account that is associated with Firewall Manager\n as the Firewall Manager administrator.

" + "smithy.api#documentation": "

Returns the Organizations account that is associated with Firewall Manager as the Firewall Manager\n administrator.

" } }, "com.amazonaws.fms#GetAdminAccountRequest": { @@ -1196,7 +1280,7 @@ "RoleStatus": { "target": "com.amazonaws.fms#AccountRoleStatus", "traits": { - "smithy.api#documentation": "

The status of the Amazon Web Services account that you set as the Firewall Manager\n administrator.

" + "smithy.api#documentation": "

The status of the Amazon Web Services account that you set as the Firewall Manager administrator.

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

Returns detailed compliance information about the specified member account. Details\n include resources that are in and out of compliance with the specified policy.

\n
    \n
  • \n

    Resources are\n considered noncompliant for WAF and Shield Advanced policies if the specified policy has\n not been applied to them.

    \n
    • \n
  • \n

    Resources are considered noncompliant for security group policies if\n they are in scope of the policy, they violate one or more of the policy rules, and remediation\n is disabled or not possible.

    \n
    • \n
  • \n

    Resources are considered noncompliant for Network Firewall policies\n if a firewall is missing in the VPC, if the firewall endpoint isn't set up in an expected Availability Zone and subnet, \n if a subnet created by the Firewall Manager doesn't have the expected route table, \n and for modifications to a firewall policy that violate the Firewall Manager policy's rules.

    \n
    • \n
  • \n

    Resources are considered noncompliant for DNS Firewall policies\n if a DNS Firewall rule group is missing from the rule group associations for the VPC.

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

Returns detailed compliance information about the specified member account. Details\n include resources that are in and out of compliance with the specified policy.

\n
    \n
  • \n

    Resources are considered noncompliant for WAF and Shield Advanced policies\n if the specified policy has not been applied to them.

    \n
    • \n
  • \n

    Resources are considered noncompliant for security group policies if they are in\n scope of the policy, they violate one or more of the policy rules, and remediation is\n disabled or not possible.

    \n
    • \n
  • \n

    Resources are considered noncompliant for Network Firewall policies if a firewall is\n missing in the VPC, if the firewall endpoint isn't set up in an expected Availability\n Zone and subnet, if a subnet created by the Firewall Manager doesn't have the expected route\n table, and for modifications to a firewall policy that violate the Firewall Manager policy's\n rules.

    \n
    • \n
  • \n

    Resources are considered noncompliant for DNS Firewall policies if a DNS Firewall\n rule group is missing from the rule group associations for the VPC.

    \n
    • \n
" } }, "com.amazonaws.fms#GetComplianceDetailRequest": { @@ -1291,7 +1375,7 @@ "PolicyId": { "target": "com.amazonaws.fms#PolicyId", "traits": { - "smithy.api#documentation": "

The ID of the policy that you want to get the details for. PolicyId is\n returned by PutPolicy and by ListPolicies.

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

The ID of the policy that you want to get the details for. PolicyId is\n returned by PutPolicy and by ListPolicies.

", "smithy.api#required": {} } }, @@ -1310,7 +1394,7 @@ "PolicyComplianceDetail": { "target": "com.amazonaws.fms#PolicyComplianceDetail", "traits": { - "smithy.api#documentation": "

Information about the resources and the policy that you specified in the\n GetComplianceDetail request.

" + "smithy.api#documentation": "

Information about the resources and the policy that you specified in the\n GetComplianceDetail request.

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

Information\n about the Amazon Simple Notification Service (SNS) topic that is used to\n record Firewall Manager SNS logs.

" + "smithy.api#documentation": "

Information\n about the Amazon Simple Notification Service (SNS) topic that is used to\n record Firewall Manager SNS logs.

" } }, "com.amazonaws.fms#GetNotificationChannelRequest": { @@ -1434,7 +1518,7 @@ } ], "traits": { - "smithy.api#documentation": "

If you created a Shield Advanced policy, returns policy-level attack summary information\n in the event of a potential DDoS attack. Other policy types are currently unsupported.

" + "smithy.api#documentation": "

If you created a Shield Advanced policy, returns policy-level attack summary information\n in the event of a potential DDoS attack. Other policy types are currently\n unsupported.

" } }, "com.amazonaws.fms#GetProtectionStatusRequest": { @@ -1456,25 +1540,25 @@ "StartTime": { "target": "com.amazonaws.fms#TimeStamp", "traits": { - "smithy.api#documentation": "

The start of the time period to query for the attacks. This is a timestamp type. The\n request syntax listing indicates a number type because the default used by Firewall Manager is Unix time in seconds. However, any valid timestamp format is\n allowed.

" + "smithy.api#documentation": "

The start of the time period to query for the attacks. This is a timestamp\n type. The request syntax listing indicates a number type because the default\n used by Firewall Manager is Unix time in seconds. However, any valid timestamp format\n is allowed.

" } }, "EndTime": { "target": "com.amazonaws.fms#TimeStamp", "traits": { - "smithy.api#documentation": "

The end of the time period to query for the attacks. This is a timestamp type. The\n request syntax listing indicates a number type because the default used by Firewall Manager is Unix time in seconds. However, any valid timestamp format is\n allowed.

" + "smithy.api#documentation": "

The end of the time period to query for the attacks. This is a timestamp\n type. The request syntax listing indicates a number type because the default\n used by Firewall Manager is Unix time in seconds. However, any valid timestamp format\n is allowed.

" } }, "NextToken": { "target": "com.amazonaws.fms#PaginationToken", "traits": { - "smithy.api#documentation": "

If you specify a value for MaxResults and you have more objects than the number that you specify \n for MaxResults, Firewall Manager returns a NextToken value in the response, which you can use to retrieve another group of \n objects. For the second and subsequent GetProtectionStatus requests, specify the value of NextToken \n from the previous response to get information about another batch of objects.

" + "smithy.api#documentation": "

If you specify a value for MaxResults and you have more objects than the\n number that you specify for MaxResults, Firewall Manager returns a\n NextToken value in the response, which you can use to retrieve another\n group of objects. For the second and subsequent GetProtectionStatus requests,\n specify the value of NextToken from the previous response to get information\n about another batch of objects.

" } }, "MaxResults": { "target": "com.amazonaws.fms#PaginationMaxResults", "traits": { - "smithy.api#documentation": "

Specifies the number of objects that you want Firewall Manager to return for this request. If you have more \n objects than the number that you specify for MaxResults, the response includes a \n NextToken value that you can use to get another batch of objects.

" + "smithy.api#documentation": "

Specifies the number of objects that you want Firewall Manager to return for this request. If\n you have more objects than the number that you specify for MaxResults, the\n response includes a NextToken value that you can use to get another batch of\n objects.

" } } } @@ -1503,7 +1587,7 @@ "NextToken": { "target": "com.amazonaws.fms#PaginationToken", "traits": { - "smithy.api#documentation": "

If you have more objects than the number that you specified for MaxResults in the request, \n the response includes a NextToken value. To list more objects, submit another \n GetProtectionStatus request, and specify the NextToken value from the response in the \n NextToken value in the next request.

\n

Amazon Web Services SDKs provide auto-pagination that identify NextToken in a response and\n make subsequent request calls automatically on your behalf. However, this feature is not\n supported by GetProtectionStatus. You must submit subsequent requests with\n NextToken using your own processes.

" + "smithy.api#documentation": "

If you have more objects than the number that you specified for MaxResults\n in the request, the response includes a NextToken value. To list more objects,\n submit another GetProtectionStatus request, and specify the\n NextToken value from the response in the NextToken value in\n the next request.

\n

Amazon Web Services SDKs provide auto-pagination that identify NextToken in a response\n and make subsequent request calls automatically on your behalf. However, this feature is\n not supported by GetProtectionStatus. You must submit subsequent requests with\n NextToken using your own processes.

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

Retrieves violations for a resource based on the specified Firewall Manager policy and Amazon Web Services account.

" + "smithy.api#documentation": "

Retrieves violations for a resource based on the specified Firewall Manager policy and Amazon Web Services\n account.

" } }, "com.amazonaws.fms#GetViolationDetailsRequest": { @@ -1595,7 +1679,7 @@ "PolicyId": { "target": "com.amazonaws.fms#PolicyId", "traits": { - "smithy.api#documentation": "

The ID of the Firewall Manager policy that you want the details for. This currently only supports security group content audit policies.

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

The ID of the Firewall Manager policy that you want the details for. This currently only\n supports security group content audit policies.

", "smithy.api#required": {} } }, @@ -1616,7 +1700,7 @@ "ResourceType": { "target": "com.amazonaws.fms#ResourceType", "traits": { - "smithy.api#documentation": "

The resource type. This is in the format shown in the Amazon Web Services Resource Types Reference.\n Supported resource types are:\n AWS::EC2::Instance,\n AWS::EC2::NetworkInterface, \n AWS::EC2::SecurityGroup,\n AWS::NetworkFirewall::FirewallPolicy, and\n AWS::EC2::Subnet.\n

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

The resource type. This is in the format shown in the Amazon Web Services\n Resource Types Reference. Supported resource types are:\n AWS::EC2::Instance, AWS::EC2::NetworkInterface,\n AWS::EC2::SecurityGroup, AWS::NetworkFirewall::FirewallPolicy,\n and AWS::EC2::Subnet.

", "smithy.api#required": {} } } @@ -1651,7 +1735,7 @@ } }, "traits": { - "smithy.api#documentation": "

The operation failed because of a system problem, even though the request was valid. Retry\n your request.

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

The operation failed because of a system problem, even though the request was valid.\n Retry your request.

", "smithy.api#error": "client" } }, @@ -1675,7 +1759,7 @@ } }, "traits": { - "smithy.api#documentation": "

The operation failed because there was nothing to do or the operation wasn't possible. For example, you might have\n submitted an AssociateAdminAccount request for an account ID that \n was already set as the Firewall Manager administrator. Or you might have tried to access a Region\n that's disabled by default, and that you need to enable for the Firewall Manager \n administrator account and for Organizations before you can access it.

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

The operation failed because there was nothing to do or the operation wasn't possible.\n For example, you might have submitted an AssociateAdminAccount request for an\n account ID that was already set as the Firewall Manager administrator. Or you might have tried to\n access a Region that's disabled by default, and that you need to enable for the Firewall Manager\n administrator account and for Organizations before you can access it.

", "smithy.api#error": "client" } }, @@ -1723,7 +1807,7 @@ } }, "traits": { - "smithy.api#documentation": "

The operation exceeds a resource limit, for example, the maximum number of\n policy objects that you can create for an Amazon Web Services account. For more information,\n see Firewall\n Manager Limits in the WAF Developer Guide.

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

The operation exceeds a resource limit, for example, the maximum number of\n policy objects that you can create for an Amazon Web Services account. For more\n information, see Firewall Manager Limits in the\n WAF Developer Guide.

", "smithy.api#error": "client" } }, @@ -1771,13 +1855,13 @@ "NextToken": { "target": "com.amazonaws.fms#PaginationToken", "traits": { - "smithy.api#documentation": "

If you specify a value for MaxResults in your list request, and you have more objects than the maximum, \n Firewall Manager returns this token in the response. For all but the first request, you provide the token returned by the prior request \n in the request parameters, to retrieve the next batch of objects.

" + "smithy.api#documentation": "

If you specify a value for MaxResults in your list request, and you have\n more objects than the maximum, Firewall Manager returns this token in the response. For all but\n the first request, you provide the token returned by the prior request in the request\n parameters, to retrieve the next batch of objects.

" } }, "MaxResults": { "target": "com.amazonaws.fms#PaginationMaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of objects that you want Firewall Manager to return for this request. If more\n objects are available, in the response, Firewall Manager provides a\n NextToken value that you can use in a subsequent call to get the next batch of objects.

\n

If you don't specify this, Firewall Manager returns all available objects.

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

The maximum number of objects that you want Firewall Manager to return for this request. If\n more objects are available, in the response, Firewall Manager provides a NextToken\n value that you can use in a subsequent call to get the next batch of objects.

\n

If you don't specify this, Firewall Manager returns all available objects.

", "smithy.api#required": {} } } @@ -1795,7 +1879,7 @@ "NextToken": { "target": "com.amazonaws.fms#PaginationToken", "traits": { - "smithy.api#documentation": "

If you specify a value for MaxResults in your list request, and you have more objects than the maximum, \n Firewall Manager returns this token in the response. You can use this token in subsequent requests to retrieve the next batch of objects.

" + "smithy.api#documentation": "

If you specify a value for MaxResults in your list request, and you have\n more objects than the maximum, Firewall Manager returns this token in the response. You can use\n this token in subsequent requests to retrieve the next batch of objects.

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

Returns an array of PolicyComplianceStatus objects. Use\n PolicyComplianceStatus to get a summary of which member accounts are protected\n by the specified policy.

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

Returns an array of PolicyComplianceStatus objects. Use\n PolicyComplianceStatus to get a summary of which member accounts are\n protected by the specified policy.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1839,13 +1923,13 @@ "NextToken": { "target": "com.amazonaws.fms#PaginationToken", "traits": { - "smithy.api#documentation": "

If you specify a value for MaxResults and you have more\n PolicyComplianceStatus objects than the number that you specify for\n MaxResults, Firewall Manager returns a NextToken value in the\n response that allows you to list another group of PolicyComplianceStatus objects.\n For the second and subsequent ListComplianceStatus requests, specify the value of\n NextToken from the previous response to get information about another batch of\n PolicyComplianceStatus objects.

" + "smithy.api#documentation": "

If you specify a value for MaxResults and you have more\n PolicyComplianceStatus objects than the number that you specify for\n MaxResults, Firewall Manager returns a NextToken value in the\n response that allows you to list another group of PolicyComplianceStatus\n objects. For the second and subsequent ListComplianceStatus requests, specify\n the value of NextToken from the previous response to get information about\n another batch of PolicyComplianceStatus objects.

" } }, "MaxResults": { "target": "com.amazonaws.fms#PaginationMaxResults", "traits": { - "smithy.api#documentation": "

Specifies the number of PolicyComplianceStatus objects that you want \n Firewall Manager to return for this request. If you have more\n PolicyComplianceStatus objects than the number that you specify for\n MaxResults, the response includes a NextToken value that you can\n use to get another batch of PolicyComplianceStatus objects.

" + "smithy.api#documentation": "

Specifies the number of PolicyComplianceStatus objects that you want Firewall Manager\n to return for this request. If you have more PolicyComplianceStatus objects\n than the number that you specify for MaxResults, the response includes a\n NextToken value that you can use to get another batch of\n PolicyComplianceStatus objects.

" } } } @@ -1862,7 +1946,7 @@ "NextToken": { "target": "com.amazonaws.fms#PaginationToken", "traits": { - "smithy.api#documentation": "

If you have more PolicyComplianceStatus objects than the number that you\n specified for MaxResults in the request, the response includes a\n NextToken value. To list more PolicyComplianceStatus objects,\n submit another ListComplianceStatus request, and specify the\n NextToken value from the response in the NextToken value in the\n next request.

" + "smithy.api#documentation": "

If you have more PolicyComplianceStatus objects than the number that you\n specified for MaxResults in the request, the response includes a\n NextToken value. To list more PolicyComplianceStatus objects,\n submit another ListComplianceStatus request, and specify the\n NextToken value from the response in the NextToken value in\n the next request.

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

Returns a MemberAccounts object that lists the member accounts in the\n administrator's Amazon Web Services organization.

\n

The ListMemberAccounts must be submitted by the account that is set as the\n Firewall Manager administrator.

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

Returns a MemberAccounts object that lists the member accounts in the\n administrator's Amazon Web Services organization.

\n

The ListMemberAccounts must be submitted by the account that is set as the\n Firewall Manager administrator.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1909,13 +1993,13 @@ "NextToken": { "target": "com.amazonaws.fms#PaginationToken", "traits": { - "smithy.api#documentation": "

If you specify a value for MaxResults and you have more account IDs than the\n number that you specify for MaxResults, Firewall Manager returns a\n NextToken value in the response that allows you to list another group of IDs.\n For the second and subsequent ListMemberAccountsRequest requests, specify the\n value of NextToken from the previous response to get information about another\n batch of member account IDs.

" + "smithy.api#documentation": "

If you specify a value for MaxResults and you have more account IDs than\n the number that you specify for MaxResults, Firewall Manager returns a\n NextToken value in the response that allows you to list another group of\n IDs. For the second and subsequent ListMemberAccountsRequest requests, specify\n the value of NextToken from the previous response to get information about\n another batch of member account IDs.

" } }, "MaxResults": { "target": "com.amazonaws.fms#PaginationMaxResults", "traits": { - "smithy.api#documentation": "

Specifies the number of member account IDs that you want Firewall Manager to return\n for this request. If you have more IDs than the number that you specify for\n MaxResults, the response includes a NextToken value that you can\n use to get another batch of member account IDs.

" + "smithy.api#documentation": "

Specifies the number of member account IDs that you want Firewall Manager to return for this\n request. If you have more IDs than the number that you specify for MaxResults,\n the response includes a NextToken value that you can use to get another batch\n of member account IDs.

" } } } @@ -1932,7 +2016,7 @@ "NextToken": { "target": "com.amazonaws.fms#PaginationToken", "traits": { - "smithy.api#documentation": "

If you have more member account IDs than the number that you specified for\n MaxResults in the request, the response includes a NextToken\n value. To list more IDs, submit another ListMemberAccounts request, and specify\n the NextToken value from the response in the NextToken value in the\n next request.

" + "smithy.api#documentation": "

If you have more member account IDs than the number that you specified for\n MaxResults in the request, the response includes a NextToken\n value. To list more IDs, submit another ListMemberAccounts request, and\n specify the NextToken value from the response in the NextToken\n value in the next request.

" } } } @@ -1975,13 +2059,13 @@ "NextToken": { "target": "com.amazonaws.fms#PaginationToken", "traits": { - "smithy.api#documentation": "

If you specify a value for MaxResults and you have more\n PolicySummary objects than the number that you specify for\n MaxResults, Firewall Manager returns a NextToken value in the\n response that allows you to list another group of PolicySummary objects. For the\n second and subsequent ListPolicies requests, specify the value of\n NextToken from the previous response to get information about another batch of\n PolicySummary objects.

" + "smithy.api#documentation": "

If you specify a value for MaxResults and you have more\n PolicySummary objects than the number that you specify for\n MaxResults, Firewall Manager returns a NextToken value in the\n response that allows you to list another group of PolicySummary objects. For\n the second and subsequent ListPolicies requests, specify the value of\n NextToken from the previous response to get information about another batch\n of PolicySummary objects.

" } }, "MaxResults": { "target": "com.amazonaws.fms#PaginationMaxResults", "traits": { - "smithy.api#documentation": "

Specifies the number of PolicySummary objects that you want Firewall Manager to return for this request. If you have more PolicySummary objects than\n the number that you specify for MaxResults, the response includes a\n NextToken value that you can use to get another batch of\n PolicySummary objects.

" + "smithy.api#documentation": "

Specifies the number of PolicySummary objects that you want Firewall Manager to\n return for this request. If you have more PolicySummary objects than the\n number that you specify for MaxResults, the response includes a\n NextToken value that you can use to get another batch of\n PolicySummary objects.

" } } } @@ -1998,7 +2082,7 @@ "NextToken": { "target": "com.amazonaws.fms#PaginationToken", "traits": { - "smithy.api#documentation": "

If you have more PolicySummary objects than the number that you specified for\n MaxResults in the request, the response includes a NextToken\n value. To list more PolicySummary objects, submit another\n ListPolicies request, and specify the NextToken value from the\n response in the NextToken value in the next request.

" + "smithy.api#documentation": "

If you have more PolicySummary objects than the number that you specified\n for MaxResults in the request, the response includes a NextToken\n value. To list more PolicySummary objects, submit another\n ListPolicies request, and specify the NextToken value from the\n response in the NextToken value in the next request.

" } } } @@ -2044,13 +2128,13 @@ "NextToken": { "target": "com.amazonaws.fms#PaginationToken", "traits": { - "smithy.api#documentation": "

If you specify a value for MaxResults in your list request, and you have more objects than the maximum, \n Firewall Manager returns this token in the response. For all but the first request, you provide the token returned by the prior request \n in the request parameters, to retrieve the next batch of objects.

" + "smithy.api#documentation": "

If you specify a value for MaxResults in your list request, and you have\n more objects than the maximum, Firewall Manager returns this token in the response. For all but\n the first request, you provide the token returned by the prior request in the request\n parameters, to retrieve the next batch of objects.

" } }, "MaxResults": { "target": "com.amazonaws.fms#PaginationMaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of objects that you want Firewall Manager to return for this request. If more\n objects are available, in the response, Firewall Manager provides a\n NextToken value that you can use in a subsequent call to get the next batch of objects.

\n

If you don't specify this, Firewall Manager returns all available objects.

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

The maximum number of objects that you want Firewall Manager to return for this request. If\n more objects are available, in the response, Firewall Manager provides a NextToken\n value that you can use in a subsequent call to get the next batch of objects.

\n

If you don't specify this, Firewall Manager returns all available objects.

", "smithy.api#required": {} } } @@ -2068,7 +2152,7 @@ "NextToken": { "target": "com.amazonaws.fms#PaginationToken", "traits": { - "smithy.api#documentation": "

If you specify a value for MaxResults in your list request, and you have more objects than the maximum, \n Firewall Manager returns this token in the response. You can use this token in subsequent requests to retrieve the next batch of objects.

" + "smithy.api#documentation": "

If you specify a value for MaxResults in your list request, and you have\n more objects than the maximum, Firewall Manager returns this token in the response. You can use\n this token in subsequent requests to retrieve the next batch of objects.

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

Retrieves the list of tags for the specified Amazon Web Services resource.

" + "smithy.api#documentation": "

Retrieves the list of tags for the specified Amazon Web Services resource.

" } }, "com.amazonaws.fms#ListTagsForResourceRequest": { @@ -2105,7 +2189,7 @@ "ResourceArn": { "target": "com.amazonaws.fms#ResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to return tags for. The Firewall Manager resources that support tagging are policies, applications lists, and protocols lists.

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

The Amazon Resource Name (ARN) of the resource to return tags for. The Firewall Manager\n resources that support tagging are policies, applications lists, and protocols lists.\n

", "smithy.api#required": {} } } @@ -2129,7 +2213,7 @@ "min": 1, "max": 8192 }, - "smithy.api#pattern": ".*" + "smithy.api#pattern": "^((?!\\\\[nr]).)+$" } }, "com.amazonaws.fms#MemberAccounts": { @@ -2183,7 +2267,7 @@ } }, "traits": { - "smithy.api#documentation": "

Violation detail for an internet gateway route with an inactive state in the customer subnet route table or Network Firewall subnet route table.

" + "smithy.api#documentation": "

Violation detail for an internet gateway route with an inactive state in the customer\n subnet route table or Network Firewall subnet route table.

" } }, "com.amazonaws.fms#NetworkFirewallInternetTrafficNotInspectedViolation": { @@ -2281,7 +2365,7 @@ } }, "traits": { - "smithy.api#documentation": "

Violation detail for the subnet for which internet traffic that hasn't been inspected.

" + "smithy.api#documentation": "

Violation detail for the subnet for which internet traffic that hasn't been\n inspected.

" } }, "com.amazonaws.fms#NetworkFirewallInvalidRouteConfigurationViolation": { @@ -2385,7 +2469,7 @@ } }, "traits": { - "smithy.api#documentation": "

Violation detail for the improperly configured subnet route. It's possible there is a missing route table route,\n or a configuration that causes traffic to cross an Availability Zone boundary.

" + "smithy.api#documentation": "

Violation detail for the improperly configured subnet route. It's possible there is a\n missing route table route, or a configuration that causes traffic to cross an Availability\n Zone boundary.

" } }, "com.amazonaws.fms#NetworkFirewallMissingExpectedRTViolation": { @@ -2412,7 +2496,7 @@ "CurrentRouteTable": { "target": "com.amazonaws.fms#ResourceId", "traits": { - "smithy.api#documentation": "

The resource ID of the current route table that's associated with the subnet, if one is available.

" + "smithy.api#documentation": "

The resource ID of the current route table that's associated with the subnet, if one is\n available.

" } }, "ExpectedRouteTable": { @@ -2423,7 +2507,7 @@ } }, "traits": { - "smithy.api#documentation": "

Violation detail for Network Firewall for a subnet that's not associated to the expected\n Firewall Manager managed route table.

" + "smithy.api#documentation": "

Violation detail for Network Firewall for a subnet that's not associated to the expected Firewall Manager\n managed route table.

" } }, "com.amazonaws.fms#NetworkFirewallMissingExpectedRoutesViolation": { @@ -2481,7 +2565,7 @@ } }, "traits": { - "smithy.api#documentation": "

Violation detail for Network Firewall for a subnet that doesn't have a \n Firewall Manager managed firewall in its VPC.

" + "smithy.api#documentation": "

Violation detail for Network Firewall for a subnet that doesn't have a Firewall Manager managed firewall\n in its VPC.

" } }, "com.amazonaws.fms#NetworkFirewallMissingSubnetViolation": { @@ -2513,7 +2597,21 @@ } }, "traits": { - "smithy.api#documentation": "

Violation detail for Network Firewall for an Availability Zone that's \n missing the expected Firewall Manager managed subnet.

" + "smithy.api#documentation": "

Violation detail for Network Firewall for an Availability Zone that's missing the expected\n Firewall Manager managed subnet.

" + } + }, + "com.amazonaws.fms#NetworkFirewallPolicy": { + "type": "structure", + "members": { + "FirewallDeploymentModel": { + "target": "com.amazonaws.fms#FirewallDeploymentModel", + "traits": { + "smithy.api#documentation": "

Defines the deployment model to use for the firewall policy. To use a distributed model,\n set PolicyOption to NULL.

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

Configures the firewall policy deployment model of Network Firewall. For information about\n Network Firewall deployment models, see Network Firewall example\n architectures with routing in the Network Firewall Developer\n Guide.

" } }, "com.amazonaws.fms#NetworkFirewallPolicyDescription": { @@ -2528,19 +2626,19 @@ "StatelessDefaultActions": { "target": "com.amazonaws.fms#NetworkFirewallActionList", "traits": { - "smithy.api#documentation": "

The actions to take on packets that don't match any of the stateless rule groups.

" + "smithy.api#documentation": "

The actions to take on packets that don't match any of the stateless rule groups.\n

" } }, "StatelessFragmentDefaultActions": { "target": "com.amazonaws.fms#NetworkFirewallActionList", "traits": { - "smithy.api#documentation": "

The actions to take on packet fragments that don't match any of the stateless rule groups.

" + "smithy.api#documentation": "

The actions to take on packet fragments that don't match any of the stateless rule\n groups.

" } }, "StatelessCustomActions": { "target": "com.amazonaws.fms#NetworkFirewallActionList", "traits": { - "smithy.api#documentation": "

Names of custom actions that are available for use in the stateless default actions settings.

" + "smithy.api#documentation": "

Names of custom actions that are available for use in the stateless default actions\n settings.

" } }, "StatefulRuleGroups": { @@ -2572,12 +2670,12 @@ "ExpectedPolicyDescription": { "target": "com.amazonaws.fms#NetworkFirewallPolicyDescription", "traits": { - "smithy.api#documentation": "

The policy that should be in use in the individual account in order to be compliant.

" + "smithy.api#documentation": "

The policy that should be in use in the individual account in order to be compliant.\n

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

Violation detail for Network Firewall for a firewall policy that has a different\n NetworkFirewallPolicyDescription than is required by the Firewall Manager policy.

" + "smithy.api#documentation": "

Violation detail for Network Firewall for a firewall policy that has a different NetworkFirewallPolicyDescription than is required by the Firewall Manager policy.\n

" } }, "com.amazonaws.fms#NetworkFirewallResourceName": { @@ -2646,7 +2744,7 @@ "RouteTableId": { "target": "com.amazonaws.fms#ResourceId", "traits": { - "smithy.api#documentation": "

Information about the route table.

" + "smithy.api#documentation": "

Information about the route table.

" } }, "VpcId": { @@ -2703,7 +2801,7 @@ } }, "traits": { - "smithy.api#documentation": "

The reference rule that partially matches the ViolationTarget rule and violation reason.

" + "smithy.api#documentation": "

The reference rule that partially matches the ViolationTarget rule and\n violation reason.

" } }, "com.amazonaws.fms#PartialMatches": { @@ -2731,7 +2829,7 @@ "PolicyUpdateToken": { "target": "com.amazonaws.fms#PolicyUpdateToken", "traits": { - "smithy.api#documentation": "

A unique identifier for each update to the policy. When issuing a PutPolicy\n request, the PolicyUpdateToken in the request must match the\n PolicyUpdateToken of the current policy version. To get the\n PolicyUpdateToken of the current policy version, use a GetPolicy\n request.

" + "smithy.api#documentation": "

A unique identifier for each update to the policy. When issuing a PutPolicy\n request, the PolicyUpdateToken in the request must match the\n PolicyUpdateToken of the current policy version. To get the\n PolicyUpdateToken of the current policy version, use a\n GetPolicy request.

" } }, "SecurityServicePolicyData": { @@ -2744,14 +2842,14 @@ "ResourceType": { "target": "com.amazonaws.fms#ResourceType", "traits": { - "smithy.api#documentation": "

The type of resource protected by or in scope of the policy. This is in the format shown\n in the Amazon Web Services Resource Types Reference.\n To apply this policy to multiple resource types, specify a resource type of ResourceTypeList and then specify the resource types in a ResourceTypeList.

\n

For WAF and Shield Advanced, resource types include\n AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::ElasticLoadBalancing::LoadBalancer, AWS::EC2::EIP, and\n AWS::CloudFront::Distribution. For a security group common policy, valid values\n are AWS::EC2::NetworkInterface and AWS::EC2::Instance. For a\n security group content audit policy, valid values are AWS::EC2::SecurityGroup,\n AWS::EC2::NetworkInterface, and AWS::EC2::Instance. For a security\n group usage audit policy, the value is AWS::EC2::SecurityGroup. For an Network Firewall policy or DNS Firewall policy,\n the value is AWS::EC2::VPC.

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

The type of resource protected by or in scope of the policy. This is in the format shown\n in the Amazon Web Services\n Resource Types Reference. To apply this policy to multiple resource types,\n specify a resource type of ResourceTypeList and then specify the resource\n types in a ResourceTypeList.

\n

For WAF and Shield Advanced, resource types include\n AWS::ElasticLoadBalancingV2::LoadBalancer,\n AWS::ElasticLoadBalancing::LoadBalancer, AWS::EC2::EIP, and\n AWS::CloudFront::Distribution. For a security group common policy, valid\n values are AWS::EC2::NetworkInterface and AWS::EC2::Instance. For\n a security group content audit policy, valid values are\n AWS::EC2::SecurityGroup, AWS::EC2::NetworkInterface, and\n AWS::EC2::Instance. For a security group usage audit policy, the value is\n AWS::EC2::SecurityGroup. For an Network Firewall policy or DNS Firewall policy,\n the value is AWS::EC2::VPC.

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

An array of ResourceType objects. Use this only to specify multiple resource types. To specify a single resource type, use ResourceType.

" + "smithy.api#documentation": "

An array of ResourceType objects. Use this only to specify multiple\n resource types. To specify a single resource type, use ResourceType.

" } }, "ResourceTags": { @@ -2763,7 +2861,7 @@ "ExcludeResourceTags": { "target": "com.amazonaws.fms#Boolean", "traits": { - "smithy.api#documentation": "

If set to True, resources with the tags that are specified in the\n ResourceTag array are not in scope of the policy. If set to False,\n and the ResourceTag array is not null, only resources with the specified tags are\n in scope of the policy.

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

If set to True, resources with the tags that are specified in the\n ResourceTag array are not in scope of the policy. If set to\n False, and the ResourceTag array is not null, only resources\n with the specified tags are in scope of the policy.

\n

This option isn't available for the centralized deployment model when creating policies\n to configure Network Firewall.

", "smithy.api#required": {} } }, @@ -2777,19 +2875,19 @@ "DeleteUnusedFMManagedResources": { "target": "com.amazonaws.fms#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether Firewall Manager should automatically remove protections from resources that leave the policy scope and clean up resources \n that Firewall Manager is managing for accounts when those accounts leave policy scope. For example, Firewall Manager will disassociate a Firewall Manager managed web ACL \n from a protected customer resource when the customer resource leaves policy scope.

\n

By default, Firewall Manager doesn't remove protections or delete Firewall Manager managed resources.

\n

This option is not available for Shield Advanced or WAF Classic policies.

" + "smithy.api#documentation": "

Indicates whether Firewall Manager should automatically remove protections from resources that leave the policy scope and clean up resources\n that Firewall Manager is managing for accounts when those accounts leave policy scope. For example, Firewall Manager will disassociate a Firewall Manager managed web ACL\n from a protected customer resource when the customer resource leaves policy scope.

\n

By default, Firewall Manager doesn't remove protections or delete Firewall Manager managed resources.

\n

This option is not available for Shield Advanced or WAF Classic policies.

" } }, "IncludeMap": { "target": "com.amazonaws.fms#CustomerPolicyScopeMap", "traits": { - "smithy.api#documentation": "

Specifies the Amazon Web Services account IDs and Organizations organizational units (OUs) to include in the policy. \n Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time.

\n

You can specify inclusions or exclusions, but not both. If you specify an IncludeMap, Firewall Manager \n applies the policy to all accounts specified by the IncludeMap, and \n does not evaluate any ExcludeMap specifications. If you do not specify an IncludeMap, then Firewall Manager \n applies the policy to all accounts except for those specified by the ExcludeMap.

\n

You can specify account IDs, OUs, or a combination:

\n
    \n
  • \n

    Specify account IDs by setting the key to ACCOUNT. For example, the following is a valid map: \n {“ACCOUNT” : [“accountID1”, “accountID2”]}.

    \n
    • \n
  • \n

    Specify OUs by setting the key to ORG_UNIT. For example, the following is a valid map: \n {“ORG_UNIT” : [“ouid111”, “ouid112”]}.

    \n
    • \n
  • \n

    Specify accounts and OUs together in a single map, separated with a comma. For example, the following is a valid map:\n {“ACCOUNT” : [“accountID1”, “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}.

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

Specifies the Amazon Web Services account IDs and Organizations organizational units (OUs) to include in\n the policy. Specifying an OU is the equivalent of specifying all accounts in the OU and in\n any of its child OUs, including any child OUs and accounts that are added at a later\n time.

\n

You can specify inclusions or exclusions, but not both. If you specify an\n IncludeMap, Firewall Manager applies the policy to all accounts specified by the\n IncludeMap, and does not evaluate any ExcludeMap\n specifications. If you do not specify an IncludeMap, then Firewall Manager applies the\n policy to all accounts except for those specified by the ExcludeMap.

\n

You can specify account IDs, OUs, or a combination:

\n
    \n
  • \n

    Specify account IDs by setting the key to ACCOUNT. For example, the\n following is a valid map: {“ACCOUNT” : [“accountID1”,\n “accountID2”]}.

    \n
    • \n
  • \n

    Specify OUs by setting the key to ORG_UNIT. For example, the\n following is a valid map: {“ORG_UNIT” : [“ouid111”, “ouid112”]}.

    \n
    • \n
  • \n

    Specify accounts and OUs together in a single map, separated with a comma. For\n example, the following is a valid map: {“ACCOUNT” : [“accountID1”,\n “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}.

    \n
    • \n
\n

This option isn't available for the centralized deployment model when creating policies\n to configure Network Firewall.

" } }, "ExcludeMap": { "target": "com.amazonaws.fms#CustomerPolicyScopeMap", "traits": { - "smithy.api#documentation": "

Specifies the Amazon Web Services account IDs and Organizations organizational units (OUs) to exclude from the policy. \n Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time.

\n

You can specify inclusions or exclusions, but not both. If you specify an IncludeMap, Firewall Manager \n applies the policy to all accounts specified by the IncludeMap, and \n does not evaluate any ExcludeMap specifications. If you do not specify an IncludeMap, then Firewall Manager \n applies the policy to all accounts except for those specified by the ExcludeMap.

\n

You can specify account IDs, OUs, or a combination:

\n
    \n
  • \n

    Specify account IDs by setting the key to ACCOUNT. For example, the following is a valid map: \n {“ACCOUNT” : [“accountID1”, “accountID2”]}.

    \n
    • \n
  • \n

    Specify OUs by setting the key to ORG_UNIT. For example, the following is a valid map: \n {“ORG_UNIT” : [“ouid111”, “ouid112”]}.

    \n
    • \n
  • \n

    Specify accounts and OUs together in a single map, separated with a comma. For example, the following is a valid map:\n {“ACCOUNT” : [“accountID1”, “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}.

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

Specifies the Amazon Web Services account IDs and Organizations organizational units (OUs) to exclude from\n the policy. Specifying an OU is the equivalent of specifying all accounts in the OU and in\n any of its child OUs, including any child OUs and accounts that are added at a later\n time.

\n

You can specify inclusions or exclusions, but not both. If you specify an\n IncludeMap, Firewall Manager applies the policy to all accounts specified by the\n IncludeMap, and does not evaluate any ExcludeMap\n specifications. If you do not specify an IncludeMap, then Firewall Manager applies the\n policy to all accounts except for those specified by the ExcludeMap.

\n

You can specify account IDs, OUs, or a combination:

\n
    \n
  • \n

    Specify account IDs by setting the key to ACCOUNT. For example, the\n following is a valid map: {“ACCOUNT” : [“accountID1”,\n “accountID2”]}.

    \n
    • \n
  • \n

    Specify OUs by setting the key to ORG_UNIT. For example, the\n following is a valid map: {“ORG_UNIT” : [“ouid111”, “ouid112”]}.

    \n
    • \n
  • \n

    Specify accounts and OUs together in a single map, separated with a comma. For\n example, the following is a valid map: {“ACCOUNT” : [“accountID1”,\n “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}.

    \n
    • \n
\n

This option isn't available for the centralized deployment model when creating policies\n to configure Network Firewall.

" } } }, @@ -2821,30 +2919,30 @@ "Violators": { "target": "com.amazonaws.fms#ComplianceViolators", "traits": { - "smithy.api#documentation": "

An array of resources that aren't protected by the WAF or Shield Advanced policy or\n that aren't in compliance with the security group policy.

" + "smithy.api#documentation": "

An array of resources that aren't protected by the WAF or Shield Advanced policy\n or that aren't in compliance with the security group policy.

" } }, "EvaluationLimitExceeded": { "target": "com.amazonaws.fms#Boolean", "traits": { - "smithy.api#documentation": "

Indicates if over 100 resources are noncompliant with the Firewall Manager\n policy.

" + "smithy.api#documentation": "

Indicates if over 100 resources are noncompliant with the Firewall Manager policy.

" } }, "ExpiredAt": { "target": "com.amazonaws.fms#TimeStamp", "traits": { - "smithy.api#documentation": "

A timestamp that indicates when the returned information should be considered out of\n date.

" + "smithy.api#documentation": "

A timestamp that indicates when the returned information should be considered out of\n date.

" } }, "IssueInfoMap": { "target": "com.amazonaws.fms#IssueInfoMap", "traits": { - "smithy.api#documentation": "

Details about problems with dependent services, such as WAF or Config,\n and the error message received that indicates the problem with the service.

" + "smithy.api#documentation": "

Details about problems with dependent services, such as WAF or Config, and the\n error message received that indicates the problem with the service.

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

Describes\n the noncompliant resources in a member account for a specific Firewall Manager policy. A maximum of 100 entries are displayed. If more than 100 resources are\n noncompliant, EvaluationLimitExceeded is set to True.

" + "smithy.api#documentation": "

Describes\n the noncompliant resources in a member account for a specific Firewall Manager\n policy. A maximum of 100 entries are displayed. If more than 100 resources are\n noncompliant, EvaluationLimitExceeded is set to True.

" } }, "com.amazonaws.fms#PolicyComplianceStatus": { @@ -2889,12 +2987,12 @@ "IssueInfoMap": { "target": "com.amazonaws.fms#IssueInfoMap", "traits": { - "smithy.api#documentation": "

Details about problems with dependent services, such as WAF or Config,\n and the error message received that indicates the problem with the service.

" + "smithy.api#documentation": "

Details about problems with dependent services, such as WAF or Config, and the\n error message received that indicates the problem with the service.

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

Indicates whether the account is compliant with the specified policy. An account is\n considered noncompliant if it includes resources that are not protected by the policy, for \n WAF and Shield Advanced policies, or that are noncompliant with the policy, for security group\n policies.

" + "smithy.api#documentation": "

Indicates whether the account is compliant with the specified policy. An account is\n considered noncompliant if it includes resources that are not protected by the policy, for\n WAF and Shield Advanced policies, or that are noncompliant with the policy, for\n security group policies.

" } }, "com.amazonaws.fms#PolicyComplianceStatusList": { @@ -2928,6 +3026,20 @@ "smithy.api#pattern": "^[a-z0-9A-Z-]{36}$" } }, + "com.amazonaws.fms#PolicyOption": { + "type": "structure", + "members": { + "NetworkFirewallPolicy": { + "target": "com.amazonaws.fms#NetworkFirewallPolicy", + "traits": { + "smithy.api#documentation": "

Defines the deployment model to use for the firewall policy.

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

Contains the Network Firewall firewall policy options to configure a centralized deployment\n model.

" + } + }, "com.amazonaws.fms#PolicySummary": { "type": "structure", "members": { @@ -2952,13 +3064,13 @@ "ResourceType": { "target": "com.amazonaws.fms#ResourceType", "traits": { - "smithy.api#documentation": "

The type of resource protected by or in scope of the policy. This is in the format shown\n in the Amazon Web Services Resource Types Reference. \n For WAF and Shield Advanced, examples include\n AWS::ElasticLoadBalancingV2::LoadBalancer and\n AWS::CloudFront::Distribution. For a security group common policy, valid values\n are AWS::EC2::NetworkInterface and AWS::EC2::Instance. For a\n security group content audit policy, valid values are AWS::EC2::SecurityGroup,\n AWS::EC2::NetworkInterface, and AWS::EC2::Instance. For a security\n group usage audit policy, the value is AWS::EC2::SecurityGroup. For an Network Firewall policy or DNS Firewall policy,\n the value is AWS::EC2::VPC.

" + "smithy.api#documentation": "

The type of resource protected by or in scope of the policy. This is in the format shown\n in the Amazon Web Services\n Resource Types Reference. For WAF and Shield Advanced, examples include\n AWS::ElasticLoadBalancingV2::LoadBalancer and\n AWS::CloudFront::Distribution. For a security group common policy, valid\n values are AWS::EC2::NetworkInterface and AWS::EC2::Instance. For\n a security group content audit policy, valid values are\n AWS::EC2::SecurityGroup, AWS::EC2::NetworkInterface, and\n AWS::EC2::Instance. For a security group usage audit policy, the value is\n AWS::EC2::SecurityGroup. For an Network Firewall policy or DNS Firewall policy,\n the value is AWS::EC2::VPC.

" } }, "SecurityServiceType": { "target": "com.amazonaws.fms#SecurityServiceType", "traits": { - "smithy.api#documentation": "

The service that the policy is using to protect the resources. This specifies the type of\n policy that is created, either an WAF policy, a Shield Advanced policy, or a security\n group policy.

" + "smithy.api#documentation": "

The service that the policy is using to protect the resources. This specifies the type\n of policy that is created, either an WAF policy, a Shield Advanced policy, or a\n security group policy.

" } }, "RemediationEnabled": { @@ -2970,7 +3082,7 @@ "DeleteUnusedFMManagedResources": { "target": "com.amazonaws.fms#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether Firewall Manager should automatically remove protections from resources that leave the policy scope and clean up resources \n that Firewall Manager is managing for accounts when those accounts leave policy scope. For example, Firewall Manager will disassociate a Firewall Manager managed web ACL \n from a protected customer resource when the customer resource leaves policy scope.

\n

By default, Firewall Manager doesn't remove protections or delete Firewall Manager managed resources.

\n

This option is not available for Shield Advanced or WAF Classic policies.

" + "smithy.api#documentation": "

Indicates whether Firewall Manager should automatically remove protections from resources that leave the policy scope and clean up resources\n that Firewall Manager is managing for accounts when those accounts leave policy scope. For example, Firewall Manager will disassociate a Firewall Manager managed web ACL\n from a protected customer resource when the customer resource leaves policy scope.

\n

By default, Firewall Manager doesn't remove protections or delete Firewall Manager managed resources.

\n

This option is not available for Shield Advanced or WAF Classic policies.

" } } }, @@ -3044,7 +3156,7 @@ } }, "traits": { - "smithy.api#documentation": "

A list of possible remediation action lists. Each individual possible remediation action is a list of individual remediation actions.

" + "smithy.api#documentation": "

A list of possible remediation action lists. Each individual possible remediation action\n is a list of individual remediation actions.

" } }, "com.amazonaws.fms#PreviousAppsList": { @@ -3113,7 +3225,7 @@ "ListUpdateToken": { "target": "com.amazonaws.fms#UpdateToken", "traits": { - "smithy.api#documentation": "

A unique identifier for each update to the list. When you update \n the list, the update token must match the token of the current version of the application list. \n You can retrieve the update token by getting the list.

" + "smithy.api#documentation": "

A unique identifier for each update to the list. When you update the list, the update\n token must match the token of the current version of the application list. You can retrieve\n the update token by getting the list.

" } }, "CreateTime": { @@ -3265,7 +3377,7 @@ } ], "traits": { - "smithy.api#documentation": "

Designates the IAM role and Amazon Simple Notification Service (SNS) topic that \n Firewall Manager uses to record SNS logs.

\n

To perform this action outside of the console, you must configure the SNS topic to allow the Firewall Manager \n role AWSServiceRoleForFMS to publish SNS logs. For more information, see \n Firewall Manager required permissions for API actions in the Firewall Manager Developer Guide.

" + "smithy.api#documentation": "

Designates the IAM role and Amazon Simple Notification Service (SNS) topic that Firewall Manager\n uses to record SNS logs.

\n

To perform this action outside of the console, you must configure the SNS topic to allow\n the Firewall Manager role AWSServiceRoleForFMS to publish SNS logs. For more information,\n see Firewall Manager required permissions\n for API actions in the Firewall Manager Developer Guide.

" } }, "com.amazonaws.fms#PutNotificationChannelRequest": { @@ -3274,14 +3386,14 @@ "SnsTopicArn": { "target": "com.amazonaws.fms#ResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SNS topic that collects notifications from \n Firewall Manager.

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

The Amazon Resource Name (ARN) of the SNS topic that collects notifications from\n Firewall Manager.

", "smithy.api#required": {} } }, "SnsRoleName": { "target": "com.amazonaws.fms#ResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that allows Amazon SNS to record \n Firewall Manager activity.

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

The Amazon Resource Name (ARN) of the IAM role that allows Amazon SNS to record\n Firewall Manager activity.

", "smithy.api#required": {} } } @@ -3316,7 +3428,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an Firewall Manager policy.

\n

Firewall Manager provides the following types of policies:

\n
    \n
  • \n

    An WAF policy (type WAFV2), which defines rule groups to run first in the \n corresponding WAF web ACL and rule groups to run last in the web ACL.

    \n
    • \n
  • \n

    An WAF Classic policy (type WAF), which defines a rule group.

    \n
    • \n
  • \n

    A Shield Advanced policy, which applies Shield Advanced protection to specified\n accounts and resources.

    \n
    • \n
  • \n

    A security group policy, which manages VPC security groups across your Amazon Web Services\n organization.

    \n
    • \n
  • \n

    An Network Firewall policy, which provides firewall rules to filter network traffic in specified \n Amazon VPCs.

    \n
    • \n
  • \n

    A DNS Firewall policy, which provides Route 53 Resolver DNS Firewall rules to filter DNS queries for \n specified VPCs.

    \n
    • \n
\n

Each policy is specific to one of the types. If you want to enforce more than one\n policy type across accounts, create multiple policies. You can create multiple\n policies for each type.

\n

You must be subscribed to Shield Advanced to create a Shield Advanced policy. For more\n information about subscribing to Shield Advanced, see \n CreateSubscription.

" + "smithy.api#documentation": "

Creates an Firewall Manager policy.

\n

Firewall Manager provides the following types of policies:

\n
    \n
  • \n

    An WAF policy (type WAFV2), which defines rule groups to run first in the\n corresponding WAF web ACL and rule groups to run last in the web ACL.

    \n
    • \n
  • \n

    An WAF Classic policy (type WAF), which defines a rule group.

    \n
    • \n
  • \n

    A Shield Advanced policy, which applies Shield Advanced protection to specified\n accounts and resources.

    \n
    • \n
  • \n

    A security group policy, which manages VPC security groups across your Amazon Web Services\n organization.

    \n
    • \n
  • \n

    An Network Firewall policy, which provides firewall rules to filter network traffic in\n specified Amazon VPCs.

    \n
    • \n
  • \n

    A DNS Firewall policy, which provides Route 53 Resolver DNS Firewall rules to filter DNS\n queries for specified VPCs.

    \n
    • \n
\n

Each policy is specific to one of the types. If you want to enforce more than one policy\n type across accounts, create multiple policies. You can create multiple policies for each\n type.

\n

You must be subscribed to Shield Advanced to create a Shield Advanced policy. For more\n information about subscribing to Shield Advanced, see CreateSubscription.

" } }, "com.amazonaws.fms#PutPolicyRequest": { @@ -3457,7 +3569,7 @@ "EC2ReplaceRouteTableAssociationAction": { "target": "com.amazonaws.fms#EC2ReplaceRouteTableAssociationAction", "traits": { - "smithy.api#documentation": "

Information about the ReplaceRouteTableAssociation action in the Amazon EC2 API.

" + "smithy.api#documentation": "

Information about the ReplaceRouteTableAssociation action in the Amazon EC2\n API.

" } }, "EC2AssociateRouteTableAction": { @@ -3471,6 +3583,12 @@ "traits": { "smithy.api#documentation": "

Information about the CreateRouteTable action in the Amazon EC2 API.

" } + }, + "FMSPolicyUpdateFirewallCreationConfigAction": { + "target": "com.amazonaws.fms#FMSPolicyUpdateFirewallCreationConfigAction", + "traits": { + "smithy.api#documentation": "

The remedial action to take when updating a firewall configuration.

" + } } }, "traits": { @@ -3596,7 +3714,7 @@ } }, "traits": { - "smithy.api#documentation": "

The resource tags that Firewall Manager uses to determine if a particular resource\n should be included or excluded from the Firewall Manager policy. Tags enable you to\n categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or\n environment. Each tag consists of a key and an optional value. Firewall Manager combines the\n tags with \"AND\" so that, if you add more than one tag to a policy scope, a resource must have\n all the specified tags to be included or excluded. For more information, see \n Working with Tag Editor.

" + "smithy.api#documentation": "

The resource tags that Firewall Manager uses to determine if a particular resource should be\n included or excluded from the Firewall Manager policy. Tags enable you to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. Each tag\n consists of a key and an optional value. Firewall Manager combines the tags with \"AND\" so that, if you\n add more than one tag to a policy scope, a resource must have all the specified tags to be\n included or excluded. For more information, see Working with Tag\n Editor.

" } }, "com.amazonaws.fms#ResourceTagKey": { @@ -3671,25 +3789,25 @@ "NetworkFirewallMissingFirewallViolation": { "target": "com.amazonaws.fms#NetworkFirewallMissingFirewallViolation", "traits": { - "smithy.api#documentation": "

Violation detail for an Network Firewall policy that indicates that a subnet has no Firewall Manager \n managed firewall in its VPC.

" + "smithy.api#documentation": "

Violation detail for an Network Firewall policy that indicates that a subnet has no Firewall Manager managed\n firewall in its VPC.

" } }, "NetworkFirewallMissingSubnetViolation": { "target": "com.amazonaws.fms#NetworkFirewallMissingSubnetViolation", "traits": { - "smithy.api#documentation": "

Violation detail for an Network Firewall policy that indicates that an Availability Zone is \n missing the expected Firewall Manager managed subnet.

" + "smithy.api#documentation": "

Violation detail for an Network Firewall policy that indicates that an Availability Zone is\n missing the expected Firewall Manager managed subnet.

" } }, "NetworkFirewallMissingExpectedRTViolation": { "target": "com.amazonaws.fms#NetworkFirewallMissingExpectedRTViolation", "traits": { - "smithy.api#documentation": "

Violation detail for an Network Firewall policy that indicates that a subnet \n is not associated with the expected Firewall Manager managed route table.

" + "smithy.api#documentation": "

Violation detail for an Network Firewall policy that indicates that a subnet is not associated\n with the expected Firewall Manager managed route table.

" } }, "NetworkFirewallPolicyModifiedViolation": { "target": "com.amazonaws.fms#NetworkFirewallPolicyModifiedViolation", "traits": { - "smithy.api#documentation": "

Violation detail for an Network Firewall policy that indicates that a firewall policy \n in an individual account has been modified in a way that makes it noncompliant. \n For example, the individual account owner might have deleted a rule group, \n changed the priority of a stateless rule group, or changed a policy default action.

" + "smithy.api#documentation": "

Violation detail for an Network Firewall policy that indicates that a firewall policy in an\n individual account has been modified in a way that makes it noncompliant. For example, the\n individual account owner might have deleted a rule group, changed the priority of a\n stateless rule group, or changed a policy default action.

" } }, "NetworkFirewallInternetTrafficNotInspectedViolation": { @@ -3728,25 +3846,37 @@ "DnsRuleGroupPriorityConflictViolation": { "target": "com.amazonaws.fms#DnsRuleGroupPriorityConflictViolation", "traits": { - "smithy.api#documentation": "

Violation detail for a DNS Firewall policy that indicates that a rule group that Firewall Manager \n tried to associate with a VPC has the same priority as a rule group that's already associated.

" + "smithy.api#documentation": "

Violation detail for a DNS Firewall policy that indicates that a rule group that Firewall Manager\n tried to associate with a VPC has the same priority as a rule group that's already\n associated.

" } }, "DnsDuplicateRuleGroupViolation": { "target": "com.amazonaws.fms#DnsDuplicateRuleGroupViolation", "traits": { - "smithy.api#documentation": "

Violation detail for a DNS Firewall policy that indicates that a rule group that Firewall Manager \n tried to associate with a VPC is already associated with the VPC and can't be associated again.

" + "smithy.api#documentation": "

Violation detail for a DNS Firewall policy that indicates that a rule group that Firewall Manager\n tried to associate with a VPC is already associated with the VPC and can't be associated\n again.

" } }, "DnsRuleGroupLimitExceededViolation": { "target": "com.amazonaws.fms#DnsRuleGroupLimitExceededViolation", "traits": { - "smithy.api#documentation": "

Violation detail for a DNS Firewall policy that indicates that the VPC reached the limit for associated DNS Firewall rule groups. Firewall Manager tried to associate another rule group with the VPC and failed.

" + "smithy.api#documentation": "

Violation detail for a DNS Firewall policy that indicates that the VPC reached the limit\n for associated DNS Firewall rule groups. Firewall Manager tried to associate another rule group with\n the VPC and failed.

" } }, "PossibleRemediationActions": { "target": "com.amazonaws.fms#PossibleRemediationActions", "traits": { - "smithy.api#documentation": "

A list of possible remediation action lists. Each individual possible remediation action is a list of individual remediation actions.

" + "smithy.api#documentation": "

A list of possible remediation action lists. Each individual possible remediation action\n is a list of individual remediation actions.

" + } + }, + "FirewallSubnetIsOutOfScopeViolation": { + "target": "com.amazonaws.fms#FirewallSubnetIsOutOfScopeViolation", + "traits": { + "smithy.api#documentation": "

Contains details about the firewall subnet that violates the policy scope.

" + } + }, + "RouteHasOutOfScopeEndpointViolation": { + "target": "com.amazonaws.fms#RouteHasOutOfScopeEndpointViolation", + "traits": { + "smithy.api#documentation": "

Contains details about the route endpoint that violates the policy scope.

" } } }, @@ -3792,6 +3922,86 @@ "smithy.api#documentation": "

Describes a route in a route table.

" } }, + "com.amazonaws.fms#RouteHasOutOfScopeEndpointViolation": { + "type": "structure", + "members": { + "SubnetId": { + "target": "com.amazonaws.fms#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the subnet associated with the route that violates the policy scope.

" + } + }, + "VpcId": { + "target": "com.amazonaws.fms#ResourceId", + "traits": { + "smithy.api#documentation": "

The VPC ID of the route that violates the policy scope.

" + } + }, + "RouteTableId": { + "target": "com.amazonaws.fms#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the route table.

" + } + }, + "ViolatingRoutes": { + "target": "com.amazonaws.fms#Routes", + "traits": { + "smithy.api#documentation": "

The list of routes that violate the route table.

" + } + }, + "SubnetAvailabilityZone": { + "target": "com.amazonaws.fms#LengthBoundedString", + "traits": { + "smithy.api#documentation": "

The subnet's Availability Zone.

" + } + }, + "SubnetAvailabilityZoneId": { + "target": "com.amazonaws.fms#LengthBoundedString", + "traits": { + "smithy.api#documentation": "

The ID of the subnet's Availability Zone.

" + } + }, + "CurrentFirewallSubnetRouteTable": { + "target": "com.amazonaws.fms#ResourceId", + "traits": { + "smithy.api#documentation": "

The route table associated with the current firewall subnet.

" + } + }, + "FirewallSubnetId": { + "target": "com.amazonaws.fms#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the firewall subnet.

" + } + }, + "FirewallSubnetRoutes": { + "target": "com.amazonaws.fms#Routes", + "traits": { + "smithy.api#documentation": "

The list of firewall subnet routes.

" + } + }, + "InternetGatewayId": { + "target": "com.amazonaws.fms#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the Internet Gateway.

" + } + }, + "CurrentInternetGatewayRouteTable": { + "target": "com.amazonaws.fms#ResourceId", + "traits": { + "smithy.api#documentation": "

The current route table associated with the Internet Gateway.

" + } + }, + "InternetGatewayRoutes": { + "target": "com.amazonaws.fms#Routes", + "traits": { + "smithy.api#documentation": "

The routes in the route table associated with the Internet Gateway.

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

Contains details about the route endpoint that violates the policy scope.

" + } + }, "com.amazonaws.fms#Routes": { "type": "list", "member": { @@ -3816,7 +4026,7 @@ "RemediationResult": { "target": "com.amazonaws.fms#SecurityGroupRuleDescription", "traits": { - "smithy.api#documentation": "

The final state of the rule specified in the ViolationTarget after it is remediated.

" + "smithy.api#documentation": "

The final state of the rule specified in the ViolationTarget after it is\n remediated.

" } }, "IsDefaultAction": { @@ -3860,19 +4070,19 @@ "Protocol": { "target": "com.amazonaws.fms#LengthBoundedString", "traits": { - "smithy.api#documentation": "

The IP protocol name (tcp, udp, icmp, icmpv6) or number.

" + "smithy.api#documentation": "

The IP protocol name (tcp, udp, icmp,\n icmpv6) or number.

" } }, "FromPort": { "target": "com.amazonaws.fms#IPPortNumber", "traits": { - "smithy.api#documentation": "

The start of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types.

" + "smithy.api#documentation": "

The start of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type\n number. A value of -1 indicates all ICMP/ICMPv6 types.

" } }, "ToPort": { "target": "com.amazonaws.fms#IPPortNumber", "traits": { - "smithy.api#documentation": "

The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes.

" + "smithy.api#documentation": "

The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value\n of -1 indicates all ICMP/ICMPv6 codes.

" } } }, @@ -3886,14 +4096,20 @@ "Type": { "target": "com.amazonaws.fms#SecurityServiceType", "traits": { - "smithy.api#documentation": "

The service that the policy is using to protect the resources. This specifies the type of\n policy that is created, either an WAF policy, a Shield Advanced policy, or a security\n group policy. For security group policies, Firewall Manager supports one security group for\n each common policy and for each content audit policy. This is an adjustable limit that you can\n increase by contacting Amazon Web Services Support.

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

The service that the policy is using to protect the resources. This specifies the type\n of policy that is created, either an WAF policy, a Shield Advanced policy, or a\n security group policy. For security group policies, Firewall Manager supports one security group for\n each common policy and for each content audit policy. This is an adjustable limit that you\n can increase by contacting Amazon Web Services Support.

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

Details about the service that are specific to the service type, in JSON format.

\n
    \n
  • \n

    Example: DNS_FIREWALL\n

    \n

    \n \"{\\\"type\\\":\\\"DNS_FIREWALL\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupId\\\":\\\"rslvr-frg-1\\\",\\\"priority\\\":10}],\\\"postProcessRuleGroups\\\":[{\\\"ruleGroupId\\\":\\\"rslvr-frg-2\\\",\\\"priority\\\":9911}]}\"\n

    \n \n

    Valid values for preProcessRuleGroups are between 1 and 99. Valid values for postProcessRuleGroups are between 9901 and 10000.

    \n     \n
    • \n
  • \n

    Example: NETWORK_FIREWALL\n

    \n

    \n \"{\\\"type\\\":\\\"NETWORK_FIREWALL\\\",\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-west-1:1234567891011:stateless-rulegroup/rulegroup2\\\",\\\"priority\\\":10}],\\\"networkFirewallStatelessDefaultActions\\\":[\\\"aws:pass\\\",\\\"custom1\\\"],\\\"networkFirewallStatelessFragmentDefaultActions\\\":[\\\"custom2\\\",\\\"aws:pass\\\"],\\\"networkFirewallStatelessCustomActions\\\":[{\\\"actionName\\\":\\\"custom1\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"dimension1\\\"}]}}},{\\\"actionName\\\":\\\"custom2\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"dimension2\\\"}]}}}],\\\"networkFirewallStatefulRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-west-1:1234567891011:stateful-rulegroup/rulegroup1\\\"}],\\\"networkFirewallOrchestrationConfig\\\":{\\\"singleFirewallEndpointPerVPC\\\":true,\\\"allowedIPV4CidrList\\\":[\\\"10.24.34.0/28\\\"]} }\"\n

    \n
    • \n
  • \n

    Specification for SHIELD_ADVANCED for Amazon CloudFront distributions

    \n

    \n \"{\\\"type\\\":\\\"SHIELD_ADVANCED\\\",\\\"automaticResponseConfiguration\\\": {\\\"automaticResponseStatus\\\":\\\"ENABLED|IGNORED|DISABLED\\\", \\\"automaticResponseAction\\\":\\\"BLOCK|COUNT\\\"}, \\\"overrideCustomerWebaclClassic\\\":true|false}\"\n

    \n

    For example: \"{\\\"type\\\":\\\"SHIELD_ADVANCED\\\",\\\"automaticResponseConfiguration\\\": {\\\"automaticResponseStatus\\\":\\\"ENABLED\\\", \\\"automaticResponseAction\\\":\\\"COUNT\\\"}}\"\n

    \n

    The default value for automaticResponseStatus is IGNORED. The value for automaticResponseAction is only required when automaticResponseStatus is set to ENABLED. The default value for overrideCustomerWebaclClassic is false.

    \n

    For other resource types that you can protect with a Shield Advanced policy, this ManagedServiceData configuration is an empty string.

    \n
    • \n
  • \n

    Example: WAFV2\n

    \n

    \n \"{\\\"type\\\":\\\"WAFV2\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupArn\\\":null,\\\"overrideAction\\\":{\\\"type\\\":\\\"NONE\\\"},\\\"managedRuleGroupIdentifier\\\":{\\\"version\\\":null,\\\"vendorName\\\":\\\"AWS\\\",\\\"managedRuleGroupName\\\":\\\"AWSManagedRulesAmazonIpReputationList\\\"},\\\"ruleGroupType\\\":\\\"ManagedRuleGroup\\\",\\\"excludeRules\\\":[{\\\"name\\\":\\\"NoUserAgent_HEADER\\\"}]}],\\\"postProcessRuleGroups\\\":[],\\\"defaultAction\\\":{\\\"type\\\":\\\"ALLOW\\\"},\\\"overrideCustomerWebACLAssociation\\\":false,\\\"loggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[\\\"arn:aws:firehose:us-west-2:12345678912:deliverystream/aws-waf-logs-fms-admin-destination\\\"],\\\"redactedFields\\\":[{\\\"redactedFieldType\\\":\\\"SingleHeader\\\",\\\"redactedFieldValue\\\":\\\"Cookies\\\"},{\\\"redactedFieldType\\\":\\\"Method\\\"}]}}\"\n

    \n

    In the loggingConfiguration, you can specify one logDestinationConfigs, you can optionally provide up to 20 redactedFields, and the RedactedFieldType must be one of URI, QUERY_STRING, HEADER, or METHOD.

    \n
    • \n
  • \n

    Example: WAF Classic\n

    \n

    \n \"{\\\"type\\\": \\\"WAF\\\", \\\"ruleGroups\\\": [{\\\"id\\\":\\\"12345678-1bcd-9012-efga-0987654321ab\\\", \\\"overrideAction\\\" : {\\\"type\\\": \\\"COUNT\\\"}}], \\\"defaultAction\\\": {\\\"type\\\": \\\"BLOCK\\\"}}\"\n

    \n
    • \n
  • \n

    Example: SECURITY_GROUPS_COMMON\n

    \n

    \n \"{\\\"type\\\":\\\"SECURITY_GROUPS_COMMON\\\",\\\"revertManualSecurityGroupChanges\\\":false,\\\"exclusiveResourceSecurityGroupManagement\\\":false, \\\"applyToAllEC2InstanceENIs\\\":false,\\\"securityGroups\\\":[{\\\"id\\\":\\\" sg-000e55995d61a06bd\\\"}]}\"\n

    \n
    • \n
  • \n

    Example: Shared VPCs. Apply the preceding policy to resources in shared VPCs as well as to those in VPCs that the account owns\n

    \n

    \n \"{\\\"type\\\":\\\"SECURITY_GROUPS_COMMON\\\",\\\"revertManualSecurityGroupChanges\\\":false,\\\"exclusiveResourceSecurityGroupManagement\\\":false, \\\"applyToAllEC2InstanceENIs\\\":false,\\\"includeSharedVPC\\\":true,\\\"securityGroups\\\":[{\\\"id\\\":\\\" sg-000e55995d61a06bd\\\"}]}\"\n

    \n
    • \n
  • \n

    Example: SECURITY_GROUPS_CONTENT_AUDIT\n

    \n

    \n \"{\\\"type\\\":\\\"SECURITY_GROUPS_CONTENT_AUDIT\\\",\\\"securityGroups\\\":[{\\\"id\\\":\\\"sg-000e55995d61a06bd\\\"}],\\\"securityGroupAction\\\":{\\\"type\\\":\\\"ALLOW\\\"}}\"\n

    \n

    The security group action for content audit can be ALLOW or\n DENY. For ALLOW, all in-scope security group rules must be\n within the allowed range of the policy's security group rules. For DENY, all\n in-scope security group rules must not contain a value or a range that matches a rule\n value or range in the policy security group.

    \n
    • \n
  • \n

    Example: SECURITY_GROUPS_USAGE_AUDIT\n

    \n

    \n \"{\\\"type\\\":\\\"SECURITY_GROUPS_USAGE_AUDIT\\\",\\\"deleteUnusedSecurityGroups\\\":true,\\\"coalesceRedundantSecurityGroups\\\":true}\"\n

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

Details about the service that are specific to the service type, in JSON format.

\n
    \n
  • \n

    Example: DNS_FIREWALL\n

    \n

    \n \"{\\\"type\\\":\\\"DNS_FIREWALL\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupId\\\":\\\"rslvr-frg-1\\\",\\\"priority\\\":10}],\\\"postProcessRuleGroups\\\":[{\\\"ruleGroupId\\\":\\\"rslvr-frg-2\\\",\\\"priority\\\":9911}]}\"\n

    \n \n

    Valid values for preProcessRuleGroups are between 1 and 99. Valid\n values for postProcessRuleGroups are between 9901 and 10000.

    \n     \n
    • \n
  • \n

    Example: NETWORK_FIREWALL - Centralized deployment\n model.

    \n

    \n \"{\\\"type\\\":\\\"NETWORK_FIREWALL\\\",\\\"awsNetworkFirewallConfig\\\":{\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\",\\\"priority\\\":1}],\\\"networkFirewallStatelessDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessFragmentDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessCustomActions\\\":[{\\\"actionName\\\":\\\"customActionName\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"metricdimensionvalue\\\"}]}}}],\\\"networkFirewallStatefulRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\"}],\\\"networkFirewallLoggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"ALERT\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}},{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"FLOW\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}}],\\\"overrideExistingConfig\\\":true}},\\\"firewallDeploymentModel\\\":{\\\"centralizedFirewallDeploymentModel\\\":{\\\"centralizedFirewallOrchestrationConfig\\\":{\\\"inspectionVpcIds\\\":[{\\\"resourceId\\\":\\\"vpc-1234\\\",\\\"accountId\\\":\\\"123456789011\\\"}],\\\"firewallCreationConfig\\\":{\\\"endpointLocation\\\":{\\\"availabilityZoneConfigList\\\":[{\\\"availabilityZoneId\\\":null,\\\"availabilityZoneName\\\":\\\"us-east-1a\\\",\\\"allowedIPV4CidrList\\\":[\\\"10.0.0.0/28\\\"]}]}},\\\"allowedIPV4CidrList\\\":[]}}}}\"\n

    \n

    To use the centralized deployment model, you must set PolicyOption to\n CENTRALIZED.

    \n
    • \n
  • \n

    Example: NETWORK_FIREWALL - Distributed deployment model with\n automatic Availability Zone configuration. With automatic Availbility Zone\n configuration, Firewall Manager chooses which Availability Zones to create the endpoints in.

    \n

    \n \"{ \\\"type\\\": \\\"NETWORK_FIREWALL\\\",\n \\\"networkFirewallStatelessRuleGroupReferences\\\": [ { \\\"resourceARN\\\":\n \\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\",\n \\\"priority\\\": 1 } ], \\\"networkFirewallStatelessDefaultActions\\\": [\n \\\"aws:forward_to_sfe\\\", \\\"customActionName\\\" ],\n \\\"networkFirewallStatelessFragmentDefaultActions\\\": [ \\\"aws:forward_to_sfe\\\",\n \\\"customActionName\\\" ], \\\"networkFirewallStatelessCustomActions\\\": [ {\n \\\"actionName\\\": \\\"customActionName\\\", \\\"actionDefinition\\\": {\n \\\"publishMetricAction\\\": { \\\"dimensions\\\": [ { \\\"value\\\": \\\"metricdimensionvalue\\\"\n } ] } } } ], \\\"networkFirewallStatefulRuleGroupReferences\\\": [ { \\\"resourceARN\\\":\n \\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\" } ],\n \\\"networkFirewallOrchestrationConfig\\\": { \\\"singleFirewallEndpointPerVPC\\\": false,\n \\\"allowedIPV4CidrList\\\": [ \\\"10.0.0.0/28\\\", \\\"192.168.0.0/28\\\" ],\n \\\"routeManagementAction\\\": \\\"OFF\\\" }, \\\"networkFirewallLoggingConfiguration\\\": {\n \\\"logDestinationConfigs\\\": [ { \\\"logDestinationType\\\": \\\"S3\\\", \\\"logType\\\":\n \\\"ALERT\\\", \\\"logDestination\\\": { \\\"bucketName\\\": \\\"s3-bucket-name\\\" } }, {\n \\\"logDestinationType\\\": \\\"S3\\\", \\\"logType\\\": \\\"FLOW\\\", \\\"logDestination\\\": {\n \\\"bucketName\\\": \\\"s3-bucket-name\\\" } } ], \\\"overrideExistingConfig\\\": true }\n }\"\n

    \n

    To use the distributed deployment model, you must set PolicyOption to\n NULL.

    \n
    • \n
  • \n

    Example: NETWORK_FIREWALL - Distributed deployment model with\n automatic Availability Zone configuration, and route management.

    \n

    \n \"{ \\\"type\\\": \\\"NETWORK_FIREWALL\\\",\n \\\"networkFirewallStatelessRuleGroupReferences\\\": [ { \\\"resourceARN\\\":\n \\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\",\n \\\"priority\\\": 1 } ], \\\"networkFirewallStatelessDefaultActions\\\": [\n \\\"aws:forward_to_sfe\\\", \\\"customActionName\\\" ],\n \\\"networkFirewallStatelessFragmentDefaultActions\\\": [ \\\"aws:forward_to_sfe\\\",\n \\\"customActionName\\\" ], \\\"networkFirewallStatelessCustomActions\\\": [ {\n \\\"actionName\\\": \\\"customActionName\\\", \\\"actionDefinition\\\": {\n \\\"publishMetricAction\\\": { \\\"dimensions\\\": [ { \\\"value\\\": \\\"metricdimensionvalue\\\"\n } ] } } } ], \\\"networkFirewallStatefulRuleGroupReferences\\\": [ { \\\"resourceARN\\\":\n \\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\" } ],\n \\\"networkFirewallOrchestrationConfig\\\": { \\\"singleFirewallEndpointPerVPC\\\": false,\n \\\"allowedIPV4CidrList\\\": [ \\\"10.0.0.0/28\\\", \\\"192.168.0.0/28\\\" ],\n \\\"routeManagementAction\\\": \\\"MONITOR\\\", \\\"routeManagementTargetTypes\\\": [\n \\\"InternetGateway\\\" ] }, \\\"networkFirewallLoggingConfiguration\\\": {\n \\\"logDestinationConfigs\\\": [ { \\\"logDestinationType\\\": \\\"S3\\\", \\\"logType\\\":\n \\\"ALERT\\\", \\\"logDestination\\\": { \\\"bucketName\\\": \\\"s3-bucket-name\\\" } }, {\n \\\"logDestinationType\\\": \\\"S3\\\", \\\"logType\\\": \\\"FLOW\\\", \\\"logDestination\\\": {\n \\\"bucketName\\\": \\\"s3-bucket-name\\\" } } ], \\\"overrideExistingConfig\\\": true }\n }\"\n

    \n
    • \n
  • \n

    Example: NETWORK_FIREWALL - Distributed deployment model with\n custom Availability Zone configuration. With custom Availability Zone configuration,\n you define which specific Availability Zones to create endpoints in by configuring\n firewallCreationConfig.

    \n

    \n \"{\n \\\"type\\\":\\\"NETWORK_FIREWALL\\\",\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\",\\\"priority\\\":1}],\n \\\"networkFirewallStatelessDefaultActions\\\":[ \\\"aws:forward_to_sfe\\\",\n \\\"customActionName\\\" ], \\\"networkFirewallStatelessFragmentDefaultActions\\\":[\n \\\"aws:forward_to_sfe\\\", \\\"fragmentcustomactionname\\\" ],\n \\\"networkFirewallStatelessCustomActions\\\":[ { \\\"actionName\\\":\\\"customActionName\\\",\n \\\"actionDefinition\\\":{ \\\"publishMetricAction\\\":{ \\\"dimensions\\\":[ {\n \\\"value\\\":\\\"metricdimensionvalue\\\" } ] } } }, {\n \\\"actionName\\\":\\\"fragmentcustomactionname\\\", \\\"actionDefinition\\\":{\n \\\"publishMetricAction\\\":{ \\\"dimensions\\\":[ {\n \\\"value\\\":\\\"fragmentmetricdimensionvalue\\\" } ] } } } ],\n \\\"networkFirewallStatefulRuleGroupReferences\\\":[ {\n \\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\"\n } ], \\\"networkFirewallOrchestrationConfig\\\":{ \\\"firewallCreationConfig\\\":{\n \\\"endpointLocation\\\":{ \\\"availabilityZoneConfigList\\\":[ {\n \\\"availabilityZoneId\\\":null, \\\"availabilityZoneName\\\":\\\"us-east-1a\\\",\n \\\"allowedIPV4CidrList\\\":[ \\\"10.0.0.0/28\\\" ] }, { ¯\\\"availabilityZoneId\\\":null,\n \\\"availabilityZoneName\\\":\\\"us-east-1b\\\", \\\"allowedIPV4CidrList\\\":[ \\\"10.0.0.0/28\\\"\n ] } ] } }, \\\"singleFirewallEndpointPerVPC\\\":false, \\\"allowedIPV4CidrList\\\":null,\n \\\"routeManagementAction\\\":\\\"OFF\\\", \\\"networkFirewallLoggingConfiguration\\\":{\n \\\"logDestinationConfigs\\\":[ { \\\"logDestinationType\\\":\\\"S3\\\",\n \\\"logType\\\":\\\"ALERT\\\", \\\"logDestination\\\":{ \\\"bucketName\\\":\\\"s3-bucket-name\\\" } },\n { \\\"logDestinationType\\\":\\\"S3\\\", \\\"logType\\\":\\\"FLOW\\\", \\\"logDestination\\\":{\n \\\"bucketName\\\":\\\"s3-bucket-name\\\" } } ], \\\"overrideExistingConfig\\\":boolean }\n }\"\n

    \n
    • \n
  • \n

    Example: NETWORK_FIREWALL - Distributed deployment model with\n custom Availability Zone configuration, and route management.

    \n

    \n \"{\n \\\"type\\\":\\\"NETWORK_FIREWALL\\\",\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\",\\\"priority\\\":1}],\n \\\"networkFirewallStatelessDefaultActions\\\":[ \\\"aws:forward_to_sfe\\\",\n \\\"customActionName\\\" ], \\\"networkFirewallStatelessFragmentDefaultActions\\\":[\n \\\"aws:forward_to_sfe\\\", \\\"fragmentcustomactionname\\\" ],\n \\\"networkFirewallStatelessCustomActions\\\":[ { \\\"actionName\\\":\\\"customActionName\\\",\n \\\"actionDefinition\\\":{ \\\"publishMetricAction\\\":{ \\\"dimensions\\\":[ {\n \\\"value\\\":\\\"metricdimensionvalue\\\" } ] } } }, {\n \\\"actionName\\\":\\\"fragmentcustomactionname\\\", \\\"actionDefinition\\\":{\n \\\"publishMetricAction\\\":{ \\\"dimensions\\\":[ {\n \\\"value\\\":\\\"fragmentmetricdimensionvalue\\\" } ] } } } ],\n \\\"networkFirewallStatefulRuleGroupReferences\\\":[ {\n \\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\"\n } ], \\\"networkFirewallOrchestrationConfig\\\":{ \\\"firewallCreationConfig\\\":{\n \\\"endpointLocation\\\":{ \\\"availabilityZoneConfigList\\\":[ {\n \\\"availabilityZoneId\\\":null, \\\"availabilityZoneName\\\":\\\"us-east-1a\\\",\n \\\"allowedIPV4CidrList\\\":[ \\\"10.0.0.0/28\\\" ] }, { ¯\\\"availabilityZoneId\\\":null,\n \\\"availabilityZoneName\\\":\\\"us-east-1b\\\", \\\"allowedIPV4CidrList\\\":[ \\\"10.0.0.0/28\\\"\n ] } ] } }, \\\"singleFirewallEndpointPerVPC\\\":false, \\\"allowedIPV4CidrList\\\":null,\n \\\"routeManagementAction\\\":\\\"MONITOR\\\", \\\"routeManagementTargetTypes\\\":[\n \\\"InternetGateway\\\" ], \\\"routeManagementConfig\\\":{\n \\\"allowCrossAZTrafficIfNoEndpoint\\\":true } },\n \\\"networkFirewallLoggingConfiguration\\\":{ \\\"logDestinationConfigs\\\":[ {\n \\\"logDestinationType\\\":\\\"S3\\\", \\\"logType\\\":\\\"ALERT\\\", \\\"logDestination\\\":{\n \\\"bucketName\\\":\\\"s3-bucket-name\\\" } }, { \\\"logDestinationType\\\":\\\"S3\\\",\n \\\"logType\\\":\\\"FLOW\\\", \\\"logDestination\\\":{ \\\"bucketName\\\":\\\"s3-bucket-name\\\" } }\n ], \\\"overrideExistingConfig\\\":boolean } }\"\n

    \n
    • \n
  • \n

    Specification for SHIELD_ADVANCED for Amazon CloudFront distributions

    \n

    \n \"{\\\"type\\\":\\\"SHIELD_ADVANCED\\\",\\\"automaticResponseConfiguration\\\":\n {\\\"automaticResponseStatus\\\":\\\"ENABLED|IGNORED|DISABLED\\\",\n \\\"automaticResponseAction\\\":\\\"BLOCK|COUNT\\\"},\n \\\"overrideCustomerWebaclClassic\\\":true|false}\"\n

    \n

    For example:\n \"{\\\"type\\\":\\\"SHIELD_ADVANCED\\\",\\\"automaticResponseConfiguration\\\":\n {\\\"automaticResponseStatus\\\":\\\"ENABLED\\\",\n \\\"automaticResponseAction\\\":\\\"COUNT\\\"}}\"\n

    \n

    The default value for automaticResponseStatus is\n IGNORED. The value for automaticResponseAction is only\n required when automaticResponseStatus is set to ENABLED.\n The default value for overrideCustomerWebaclClassic is\n false.

    \n

    For other resource types that you can protect with a Shield Advanced policy, this\n ManagedServiceData configuration is an empty string.

    \n
    • \n
  • \n

    Example: WAFV2\n

    \n

    \n \"{\\\"type\\\":\\\"WAFV2\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupArn\\\":null,\\\"overrideAction\\\":{\\\"type\\\":\\\"NONE\\\"},\\\"managedRuleGroupIdentifier\\\":{\\\"version\\\":null,\\\"vendorName\\\":\\\"AWS\\\",\\\"managedRuleGroupName\\\":\\\"AWSManagedRulesAmazonIpReputationList\\\"},\\\"ruleGroupType\\\":\\\"ManagedRuleGroup\\\",\\\"excludeRules\\\":[{\\\"name\\\":\\\"NoUserAgent_HEADER\\\"}]}],\\\"postProcessRuleGroups\\\":[],\\\"defaultAction\\\":{\\\"type\\\":\\\"ALLOW\\\"},\\\"overrideCustomerWebACLAssociation\\\":false,\\\"loggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[\\\"arn:aws:firehose:us-west-2:12345678912:deliverystream/aws-waf-logs-fms-admin-destination\\\"],\\\"redactedFields\\\":[{\\\"redactedFieldType\\\":\\\"SingleHeader\\\",\\\"redactedFieldValue\\\":\\\"Cookies\\\"},{\\\"redactedFieldType\\\":\\\"Method\\\"}]}}\"\n

    \n

    In the loggingConfiguration, you can specify one\n logDestinationConfigs, you can optionally provide up to 20\n redactedFields, and the RedactedFieldType must be one of\n URI, QUERY_STRING, HEADER, or\n METHOD.

    \n
    • \n
  • \n

    Example: WAF Classic\n

    \n

    \n \"{\\\"type\\\": \\\"WAF\\\", \\\"ruleGroups\\\":\n [{\\\"id\\\":\\\"12345678-1bcd-9012-efga-0987654321ab\\\", \\\"overrideAction\\\" : {\\\"type\\\":\n \\\"COUNT\\\"}}], \\\"defaultAction\\\": {\\\"type\\\": \\\"BLOCK\\\"}}\"\n

    \n
    • \n
  • \n

    Example: SECURITY_GROUPS_COMMON\n

    \n

    \n \"{\\\"type\\\":\\\"SECURITY_GROUPS_COMMON\\\",\\\"revertManualSecurityGroupChanges\\\":false,\\\"exclusiveResourceSecurityGroupManagement\\\":false,\n \\\"applyToAllEC2InstanceENIs\\\":false,\\\"securityGroups\\\":[{\\\"id\\\":\\\"\n sg-000e55995d61a06bd\\\"}]}\"\n

    \n
    • \n
  • \n

    Example: Shared VPCs. Apply the preceding policy to resources in shared VPCs as\n well as to those in VPCs that the account owns

    \n

    \n \"{\\\"type\\\":\\\"SECURITY_GROUPS_COMMON\\\",\\\"revertManualSecurityGroupChanges\\\":false,\\\"exclusiveResourceSecurityGroupManagement\\\":false,\n \\\"applyToAllEC2InstanceENIs\\\":false,\\\"includeSharedVPC\\\":true,\\\"securityGroups\\\":[{\\\"id\\\":\\\"\n sg-000e55995d61a06bd\\\"}]}\"\n

    \n
    • \n
  • \n

    Example: SECURITY_GROUPS_CONTENT_AUDIT\n

    \n

    \n \"{\\\"type\\\":\\\"SECURITY_GROUPS_CONTENT_AUDIT\\\",\\\"securityGroups\\\":[{\\\"id\\\":\\\"sg-000e55995d61a06bd\\\"}],\\\"securityGroupAction\\\":{\\\"type\\\":\\\"ALLOW\\\"}}\"\n

    \n

    The security group action for content audit can be ALLOW or\n DENY. For ALLOW, all in-scope security group rules must\n be within the allowed range of the policy's security group rules. For\n DENY, all in-scope security group rules must not contain a value or a\n range that matches a rule value or range in the policy security group.

    \n
    • \n
  • \n

    Example: SECURITY_GROUPS_USAGE_AUDIT\n

    \n

    \n \"{\\\"type\\\":\\\"SECURITY_GROUPS_USAGE_AUDIT\\\",\\\"deleteUnusedSecurityGroups\\\":true,\\\"coalesceRedundantSecurityGroups\\\":true}\"\n

    \n
    • \n
" + } + }, + "PolicyOption": { + "target": "com.amazonaws.fms#PolicyOption", + "traits": { + "smithy.api#documentation": "

Contains the Network Firewall firewall policy options to configure a centralized deployment\n model.

" } } }, @@ -3984,7 +4200,7 @@ "Priority": { "target": "com.amazonaws.fms#StatelessRuleGroupPriority", "traits": { - "smithy.api#documentation": "

The priority of the rule group. Network Firewall evaluates the stateless rule groups in a firewall policy starting from the lowest priority setting.

" + "smithy.api#documentation": "

The priority of the rule group. Network Firewall evaluates the stateless rule groups in a\n firewall policy starting from the lowest priority setting.

" } } }, @@ -4013,20 +4229,20 @@ "Key": { "target": "com.amazonaws.fms#TagKey", "traits": { - "smithy.api#documentation": "

Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as \"customer.\" Tag keys are case-sensitive.

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

Part of the key:value pair that defines a tag. You can use a tag key to describe a\n category of information, such as \"customer.\" Tag keys are case-sensitive.

", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.fms#TagValue", "traits": { - "smithy.api#documentation": "

Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as \"companyA\" or \"companyB.\" Tag values are case-sensitive.

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

Part of the key:value pair that defines a tag. You can use a tag value to describe a\n specific value within a category, such as \"companyA\" or \"companyB.\" Tag values are\n case-sensitive.

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

A collection of key:value pairs associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as \"environment\") and the tag value represents a specific value within that category (such as \"test,\" \"development,\" or \"production\"). You can add up to 50 tags to each Amazon Web Services resource.

" + "smithy.api#documentation": "

A collection of key:value pairs associated with an Amazon Web Services resource. The key:value pair\n can be anything you define. Typically, the tag key represents a category (such as\n \"environment\") and the tag value represents a specific value within that category (such as\n \"test,\" \"development,\" or \"production\"). You can add up to 50 tags to each Amazon Web Services resource.\n

" } }, "com.amazonaws.fms#TagKey": { @@ -4098,7 +4314,7 @@ "ResourceArn": { "target": "com.amazonaws.fms#ResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to return tags for. The Firewall Manager resources that support tagging are policies, applications lists, and protocols lists.

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

The Amazon Resource Name (ARN) of the resource to return tags for. The Firewall Manager\n resources that support tagging are policies, applications lists, and protocols lists.\n

", "smithy.api#required": {} } }, @@ -4223,7 +4439,7 @@ "ResourceArn": { "target": "com.amazonaws.fms#ResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to return tags for. The Firewall Manager resources that support tagging are policies, applications lists, and protocols lists.

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

The Amazon Resource Name (ARN) of the resource to return tags for. The Firewall Manager\n resources that support tagging are policies, applications lists, and protocols lists.\n

", "smithy.api#required": {} } }, @@ -4291,7 +4507,7 @@ "ResourceTags": { "target": "com.amazonaws.fms#TagList", "traits": { - "smithy.api#documentation": "

The ResourceTag objects associated with the resource.

" + "smithy.api#documentation": "

The ResourceTag objects associated with the resource.

\n

This option isn't available for the centralized deployment model when creating policies\n to configure Network Firewall.

" } }, "ResourceDescription": { @@ -4302,7 +4518,7 @@ } }, "traits": { - "smithy.api#documentation": "

Violations for a resource based on the specified Firewall Manager policy and Amazon Web Services account.

" + "smithy.api#documentation": "

Violations for a resource based on the specified Firewall Manager policy and Amazon Web Services\n account.

" } }, "com.amazonaws.fms#ViolationReason": { @@ -4408,6 +4624,14 @@ { "value": "RESOURCE_MISSING_DNS_FIREWALL", "name": "ResourceMissingDnsFirewall" + }, + { + "value": "FIREWALL_SUBNET_IS_OUT_OF_SCOPE", + "name": "FirewallSubnetIsOutOfScope" + }, + { + "value": "ROUTE_HAS_OUT_OF_SCOPE_ENDPOINT", + "name": "RouteHasOutOfScopeEndpoint" } ] } diff --git a/aws/sdk/aws-models/fsx.json b/aws/sdk/aws-models/fsx.json index e720d004d0..27f3bd7a5a 100644 --- a/aws/sdk/aws-models/fsx.json +++ b/aws/sdk/aws-models/fsx.json @@ -1208,7 +1208,7 @@ "FileSystemPath": { "target": "com.amazonaws.fsx#Namespace", "traits": { - "smithy.api#documentation": "

A path on the file system that points to a high-level directory (such\n as /ns1/) or subdirectory (such as /ns1/subdir/)\n that will be mapped 1-1 with DataRepositoryPath.\n The leading forward slash in the name is required. Two data repository\n associations cannot have overlapping file system paths. For example, if\n a data repository is associated with file system path /ns1/,\n then you cannot link another data repository with file system\n path /ns1/ns2.

\n

This path specifies where in your file system files will be exported\n from or imported to. This file system directory can be linked to only one\n Amazon S3 bucket, and no other S3 bucket can be linked to the directory.

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

A path on the file system that points to a high-level directory (such\n as /ns1/) or subdirectory (such as /ns1/subdir/)\n that will be mapped 1-1 with DataRepositoryPath.\n The leading forward slash in the name is required. Two data repository\n associations cannot have overlapping file system paths. For example, if\n a data repository is associated with file system path /ns1/,\n then you cannot link another data repository with file system\n path /ns1/ns2.

\n

This path specifies where in your file system files will be exported\n from or imported to. This file system directory can be linked to only one\n Amazon S3 bucket, and no other S3 bucket can be linked to the directory.

\n \n

If you specify only a forward slash (/) as the file system\n path, you can link only 1 data repository to the file system. You can only specify\n \"/\" as the file system path for the first data repository associated with a file system.

\n ", "smithy.api#required": {} } }, @@ -1428,7 +1428,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new Amazon FSx for Lustre, Amazon FSx for Windows File\n Server, or Amazon FSx for OpenZFS file system from an existing Amazon FSx backup.

\n \n

If a file system with the specified client request token exists and the parameters\n match, this operation returns the description of the file system. If a client request\n token with the specified by the file system exists and the parameters don't match, this\n call returns IncompatibleParameterError. If a file system with the\n specified client request token doesn't exist, this operation does the following:

\n \n
    \n
  • \n

    Creates a new Amazon FSx file system from backup with an assigned ID,\n and an initial lifecycle state of CREATING.

    \n
    • \n
  • \n

    Returns the description of the file system.

    \n
    • \n
\n\n

Parameters like the Active Directory, default share name, automatic backup, and backup\n settings default to the parameters of the file system that was backed up, unless\n overridden. You can explicitly supply other settings.

\n\n

By using the idempotent operation, you can retry a\n CreateFileSystemFromBackup call without the risk of creating an extra\n file system. This approach can be useful when an initial call fails in a way that makes\n it unclear whether a file system was created. Examples are if a transport level timeout\n occurred, or your connection was reset. If you use the same client request token and the\n initial call created a file system, the client receives a success message as long as the\n parameters are the same.

\n \n

The CreateFileSystemFromBackup call returns while the file system's\n lifecycle state is still CREATING. You can check the file-system\n creation status by calling the \n DescribeFileSystems operation, which returns the file system state along\n with other information.

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

Creates a new Amazon FSx for Lustre, Amazon FSx for Windows File\n Server, or Amazon FSx for OpenZFS file system from an existing Amazon FSx backup.

\n \n

If a file system with the specified client request token exists and the parameters\n match, this operation returns the description of the file system. If a file system\n with the specified client request token exists but the parameters don't match, this\n call returns IncompatibleParameterError. If a file system with the\n specified client request token doesn't exist, this operation does the following:

\n \n
    \n
  • \n

    Creates a new Amazon FSx file system from backup with an assigned ID,\n and an initial lifecycle state of CREATING.

    \n
    • \n
  • \n

    Returns the description of the file system.

    \n
    • \n
\n\n

Parameters like the Active Directory, default share name, automatic backup, and backup\n settings default to the parameters of the file system that was backed up, unless\n overridden. You can explicitly supply other settings.

\n\n

By using the idempotent operation, you can retry a\n CreateFileSystemFromBackup call without the risk of creating an extra\n file system. This approach can be useful when an initial call fails in a way that makes\n it unclear whether a file system was created. Examples are if a transport level timeout\n occurred, or your connection was reset. If you use the same client request token and the\n initial call created a file system, the client receives a success message as long as the\n parameters are the same.

\n \n

The CreateFileSystemFromBackup call returns while the file system's\n lifecycle state is still CREATING. You can check the file-system\n creation status by calling the \n DescribeFileSystems operation, which returns the file system state along\n with other information.

\n " } }, "com.amazonaws.fsx#CreateFileSystemFromBackupRequest": { @@ -1551,7 +1551,7 @@ "AutoImportPolicy": { "target": "com.amazonaws.fsx#AutoImportPolicyType", "traits": { - "smithy.api#documentation": "

(Optional) Available with Scratch and Persistent_1 deployment types. When you \n create your file system, your existing S3 objects appear as file and directory listings. \n Use this property to choose how Amazon FSx keeps your file and directory listings up to date \n as you add or modify objects in your linked S3 bucket. AutoImportPolicy can\n have the following values:

\n
    \n
  • \n

    \n NONE - (Default) AutoImport is off. Amazon FSx only updates \n file and directory listings from the linked S3 bucket \n when the file system is created. FSx does not update file and directory \n listings for any new or changed objects after choosing this option.

    \n
    • \n
  • \n

    \n NEW - AutoImport is on. Amazon FSx automatically imports\n directory listings of any new objects added to the linked S3 bucket that \n do not currently exist in the FSx file system.

    \n
    • \n
  • \n

    \n NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports \n file and directory listings of any new objects added to the S3 bucket and any \n existing objects that are changed in the S3 bucket after you choose this option.

    \n
    • \n
  • \n

    \n NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically\n imports file and directory listings of any new objects added to the S3 bucket, any \n existing objects that are changed in the S3 bucket, and any objects that were deleted\n in the S3 bucket.

    \n
    • \n
\n

For more information, see \n Automatically import updates from your S3 bucket.

\n \n

This parameter is not supported for file systems with the Persistent_2 deployment type.\n Instead, use CreateDataRepositoryAssociation\" to create\n a data repository association to link your Lustre file system to a data repository.

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

(Optional) Available with Scratch and Persistent_1 deployment types. When you \n create your file system, your existing S3 objects appear as file and directory listings. \n Use this property to choose how Amazon FSx keeps your file and directory listings up to date \n as you add or modify objects in your linked S3 bucket. AutoImportPolicy can\n have the following values:

\n
    \n
  • \n

    \n NONE - (Default) AutoImport is off. Amazon FSx only updates \n file and directory listings from the linked S3 bucket \n when the file system is created. FSx does not update file and directory \n listings for any new or changed objects after choosing this option.

    \n
    • \n
  • \n

    \n NEW - AutoImport is on. Amazon FSx automatically imports\n directory listings of any new objects added to the linked S3 bucket that \n do not currently exist in the FSx file system.

    \n
    • \n
  • \n

    \n NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports \n file and directory listings of any new objects added to the S3 bucket and any \n existing objects that are changed in the S3 bucket after you choose this option.

    \n
    • \n
  • \n

    \n NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically\n imports file and directory listings of any new objects added to the S3 bucket, any \n existing objects that are changed in the S3 bucket, and any objects that were deleted\n in the S3 bucket.

    \n
    • \n
\n

For more information, see \n Automatically import updates from your S3 bucket.

\n \n

This parameter is not supported for file systems with the Persistent_2 deployment type.\n Instead, use CreateDataRepositoryAssociation to create\n a data repository association to link your Lustre file system to a data repository.

\n " } }, "PerUnitStorageThroughput": { @@ -1614,7 +1614,7 @@ "EndpointIpAddressRange": { "target": "com.amazonaws.fsx#IpAddressRange", "traits": { - "smithy.api#documentation": "

Specifies the IP address range in which the endpoints to access your file system\n will be created. By default, Amazon FSx selects an unused IP address range for you\n from the 198.19.* range.

" + "smithy.api#documentation": "

Specifies the IP address range in which the endpoints to access your file system\n will be created. By default, Amazon FSx selects an unused IP address range for you\n from the 198.19.* range.

\n \n

The Endpoint IP address range you select for your file system\n must exist outside the VPC's CIDR range and must be at least /30 or larger.

\n " } }, "FsxAdminPassword": { @@ -1680,7 +1680,7 @@ "DeploymentType": { "target": "com.amazonaws.fsx#OpenZFSDeploymentType", "traits": { - "smithy.api#documentation": "

Specifies the file system deployment type. Amazon FSx for OpenZFS supports\n SINGLE_AZ_1. SINGLE_AZ_1 is a file system configured for a\n single Availability Zone (AZ) of redundancy.

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

Specifies the file system deployment type. Amazon FSx for OpenZFS supports\n SINGLE_AZ_1. SINGLE_AZ_1 deployment type is configured for redundancy\n within a single Availability Zone.

", "smithy.api#required": {} } }, @@ -1705,7 +1705,7 @@ } }, "traits": { - "smithy.api#documentation": "

The OpenZFS configuration properties for the file system that you are creating.

" + "smithy.api#documentation": "

The Amazon FSx for OpenZFS configuration properties for the file system that you are creating.

" } }, "com.amazonaws.fsx#CreateFileSystemRequest": { @@ -1947,32 +1947,38 @@ "ParentVolumeId": { "target": "com.amazonaws.fsx#VolumeId", "traits": { - "smithy.api#documentation": "

The ID of the volume to use as the parent volume.

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

The ID of the volume to use as the parent volume of the volume that you are creating.

", "smithy.api#required": {} } }, "StorageCapacityReservationGiB": { - "target": "com.amazonaws.fsx#IntegerNoMax", + "target": "com.amazonaws.fsx#IntegerNoMaxFromNegativeOne", "traits": { - "smithy.api#documentation": "

The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't\n reserve more storage than the parent volume has reserved.

" + "smithy.api#documentation": "

Specifies the amount of storage in gibibytes (GiB) to reserve from the parent volume. Setting\n StorageCapacityReservationGiB guarantees that the specified amount of storage space\n on the parent volume will always be available for the volume. \n You can't reserve more storage than the parent volume has. To not specify a storage capacity \n reservation, set this to 0 or -1. For more information, see \n Volume properties \n in the Amazon FSx for OpenZFS User Guide.

" } }, "StorageCapacityQuotaGiB": { - "target": "com.amazonaws.fsx#IntegerNoMax", + "target": "com.amazonaws.fsx#IntegerNoMaxFromNegativeOne", + "traits": { + "smithy.api#documentation": "

Sets the maximum storage size in gibibytes (GiB) for the volume. You can specify \n a quota that is larger than the storage on the parent volume. A volume quota limits \n the amount of storage that the volume can consume to the configured amount, but does not \n guarantee the space will be available on the parent volume. To guarantee quota space, you must also set \n StorageCapacityReservationGiB. To not specify a storage capacity quota, set this to -1.\n

\n

For more information, see \n Volume properties \n in the Amazon FSx for OpenZFS User Guide.

" + } + }, + "RecordSizeKiB": { + "target": "com.amazonaws.fsx#IntegerRecordSizeKiB", "traits": { - "smithy.api#documentation": "

The maximum amount of storage in gibibytes (GiB) that the volume can use from its\n parent. You can specify a quota larger than the storage on the parent volume.

" + "smithy.api#documentation": "

Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB). Valid values are 4, 8,\n 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB.\n We recommend using the default setting for the majority of use cases. \n Generally, workloads that write in fixed small or large record sizes \n may benefit from setting a custom record size, like database workloads \n (small record size) or media streaming workloads (large record size). \n For additional guidance on when\n to set a custom record size, see \n \n ZFS Record size in the Amazon FSx for OpenZFS User Guide.

" } }, "DataCompressionType": { "target": "com.amazonaws.fsx#OpenZFSDataCompressionType", "traits": { - "smithy.api#documentation": "

Specifies the method used to compress the data on the volume. Unless the compression\n type is specified, volumes inherit the DataCompressionType value of their\n parent volume.

\n
    \n
  • \n

    \n NONE - Doesn't compress the data on the volume.

    \n
    • \n
  • \n

    \n ZSTD - Compresses the data in the volume using the Zstandard\n (ZSTD) compression algorithm. This algorithm reduces the amount of space used on\n your volume and has very little impact on compute resources.

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

Specifies the method used to compress the data on the volume. The compression\n type is NONE by default.

\n
    \n
  • \n

    \n NONE - Doesn't compress the data on the volume.\n NONE is the default.

    \n
    • \n
  • \n

    \n ZSTD - Compresses the data in the volume using the Zstandard\n (ZSTD) compression algorithm. ZSTD compression provides a higher level of \n data compression and higher read throughput performance than LZ4 compression.

    \n
    • \n
  • \n

    \n LZ4 - Compresses the data in the volume using the LZ4\n compression algorithm. LZ4 compression provides a lower level of compression \n and higher write throughput performance than ZSTD compression.

    \n
    • \n
\n

For more information about volume compression types and the performance of your Amazon FSx for OpenZFS file system,\n see \n Tips for maximizing performance File system and volume settings in the Amazon FSx for OpenZFS User Guide.

" } }, "CopyTagsToSnapshots": { "target": "com.amazonaws.fsx#Flag", "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether tags for the volume should be copied to snapshots.\n This value defaults to false. If it's set to true, all tags\n for the volume are copied to snapshots where the user doesn't specify tags. If this\n value is true, and you specify one or more tags, only the specified tags\n are copied to snapshots. If you specify one or more tags when creating the snapshot, no\n tags are copied from the volume, regardless of this value.

" + "smithy.api#documentation": "

A Boolean value indicating whether tags for the volume should be copied to snapshots.\n This value defaults to false. If it's set to true, all tags\n for the volume are copied to snapshots where the user doesn't specify tags. If this\n value is true, and you specify one or more tags, only the specified tags\n are copied to snapshots. If you specify one or more tags when creating the snapshot, no\n tags are copied from the volume, regardless of this value.

" } }, "OriginSnapshot": { @@ -1984,24 +1990,24 @@ "ReadOnly": { "target": "com.amazonaws.fsx#ReadOnly", "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether the volume is read-only.

" + "smithy.api#documentation": "

A Boolean value indicating whether the volume is read-only.

" } }, "NfsExports": { "target": "com.amazonaws.fsx#OpenZFSNfsExports", "traits": { - "smithy.api#documentation": "

The configuration object for mounting a Network File System (NFS) file system.

" + "smithy.api#documentation": "

The configuration object for mounting a Network File System (NFS) file system.

" } }, "UserAndGroupQuotas": { "target": "com.amazonaws.fsx#OpenZFSUserAndGroupQuotas", "traits": { - "smithy.api#documentation": "

An object specifying how much storage users or groups can use on the volume.

" + "smithy.api#documentation": "

An object specifying how much storage users or groups can use on the volume.

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

Specifies the configuration of the OpenZFS volume that you are creating.

" + "smithy.api#documentation": "

Specifies the configuration of the Amazon FSx for OpenZFS volume that you are creating.

" } }, "com.amazonaws.fsx#CreateSnapshot": { @@ -2027,7 +2033,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a snapshot of an existing Amazon FSx for OpenZFS file system. With\n snapshots, you can easily undo file changes and compare file versions by restoring the\n volume to a previous version.

\n

If a snapshot with the specified client request token exists, and the parameters\n match, this operation returns the description of the existing snapshot. If a snapshot\n with the specified client request token exists, and the parameters don't match, this\n operation returns IncompatibleParameterError. If a snapshot with the\n specified client request token doesn't exist, CreateSnapshot does the\n following:

\n
    \n
  • \n

    Creates a new OpenZFS snapshot with an assigned ID, and an initial lifecycle\n state of CREATING.

    \n
    • \n
  • \n

    Returns the description of the snapshot.

    \n
    • \n
\n

By using the idempotent operation, you can retry a CreateSnapshot\n operation without the risk of creating an extra snapshot. This approach can be useful\n when an initial call fails in a way that makes it unclear whether a snapshot was\n created. If you use the same client request token and the initial call created a\n snapshot, the operation returns a successful result because all the parameters are the\n same.

\n

The CreateSnapshot operation returns while the snapshot's lifecycle state\n is still CREATING. You can check the snapshot creation status by calling\n the DescribeSnapshots operation, which returns the snapshot state along with\n other information.

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

Creates a snapshot of an existing Amazon FSx for OpenZFS volume. With\n snapshots, you can easily undo file changes and compare file versions by restoring the\n volume to a previous version.

\n

If a snapshot with the specified client request token exists, and the parameters\n match, this operation returns the description of the existing snapshot. If a snapshot\n with the specified client request token exists, and the parameters don't match, this\n operation returns IncompatibleParameterError. If a snapshot with the\n specified client request token doesn't exist, CreateSnapshot does the\n following:

\n
    \n
  • \n

    Creates a new OpenZFS snapshot with an assigned ID, and an initial lifecycle\n state of CREATING.

    \n
    • \n
  • \n

    Returns the description of the snapshot.

    \n
    • \n
\n

By using the idempotent operation, you can retry a CreateSnapshot\n operation without the risk of creating an extra snapshot. This approach can be useful\n when an initial call fails in a way that makes it unclear whether a snapshot was\n created. If you use the same client request token and the initial call created a\n snapshot, the operation returns a successful result because all the parameters are the\n same.

\n

The CreateSnapshot operation returns while the snapshot's lifecycle state\n is still CREATING. You can check the snapshot creation status by calling\n the DescribeSnapshots operation, which returns the snapshot state along with\n other information.

", "smithy.api#idempotent": {} } }, @@ -2214,7 +2220,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS storage\n volume.

" + "smithy.api#documentation": "

Creates an FSx for ONTAP or Amazon FSx for OpenZFS storage volume.

" } }, "com.amazonaws.fsx#CreateVolumeFromBackup": { @@ -2420,7 +2426,7 @@ "FileSystemPath": { "target": "com.amazonaws.fsx#Namespace", "traits": { - "smithy.api#documentation": "

A path on the file system that points to a high-level directory (such\n as /ns1/) or subdirectory (such as /ns1/subdir/)\n that will be mapped 1-1 with DataRepositoryPath.\n The leading forward slash in the name is required. Two data repository\n associations cannot have overlapping file system paths. For example, if\n a data repository is associated with file system path /ns1/,\n then you cannot link another data repository with file system\n path /ns1/ns2.

\n

This path specifies where in your file system files will be exported\n from or imported to. This file system directory can be linked to only one\n Amazon S3 bucket, and no other S3 bucket can be linked to the directory.

" + "smithy.api#documentation": "

A path on the file system that points to a high-level directory (such\n as /ns1/) or subdirectory (such as /ns1/subdir/)\n that will be mapped 1-1 with DataRepositoryPath.\n The leading forward slash in the name is required. Two data repository\n associations cannot have overlapping file system paths. For example, if\n a data repository is associated with file system path /ns1/,\n then you cannot link another data repository with file system\n path /ns1/ns2.

\n

This path specifies where in your file system files will be exported\n from or imported to. This file system directory can be linked to only one\n Amazon S3 bucket, and no other S3 bucket can be linked to the directory.

\n \n

If you specify only a forward slash (/) as the file system\n path, you can link only 1 data repository to the file system. You can only specify\n \"/\" as the file system path for the first data repository associated with a file system.

\n " } }, "DataRepositoryPath": { @@ -3137,15 +3143,47 @@ "SkipFinalBackup": { "target": "com.amazonaws.fsx#Flag", "traits": { - "smithy.api#documentation": "

By default, Amazon FSx for OpenZFS takes a final backup on your behalf when\n the DeleteFileSystem operation is invoked. Doing this helps protect you\n from data loss, and we highly recommend taking the final backup. If you want to skip\n this backup, use this\n value\n to do so.

" + "smithy.api#documentation": "

By default, Amazon FSx for OpenZFS takes a final backup on your behalf when\n the DeleteFileSystem operation is invoked. Doing this helps protect you\n from data loss, and we highly recommend taking the final backup. If you want to skip\n taking a final backup, set this value to true.

" } }, "FinalBackupTags": { - "target": "com.amazonaws.fsx#Tags" + "target": "com.amazonaws.fsx#Tags", + "traits": { + "smithy.api#documentation": "

A list of tags to apply to the file system's final backup.

" + } + }, + "Options": { + "target": "com.amazonaws.fsx#DeleteFileSystemOpenZFSOptions", + "traits": { + "smithy.api#documentation": "

To delete a file system if there are child volumes present below the root volume,\n use the string DELETE_CHILD_VOLUMES_AND_SNAPSHOTS. If your file system\n has child volumes and you don't use this option, the delete request will fail.

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

The configuration object for the OpenZFS file system used in the\n DeleteFileSystem operation.

" + "smithy.api#documentation": "

The configuration object for the Amazon FSx for OpenZFS file system used in the\n DeleteFileSystem operation.

" + } + }, + "com.amazonaws.fsx#DeleteFileSystemOpenZFSOption": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DELETE_CHILD_VOLUMES_AND_SNAPSHOTS", + "name": "DELETE_CHILD_VOLUMES_AND_SNAPSHOTS" + } + ] + } + }, + "com.amazonaws.fsx#DeleteFileSystemOpenZFSOptions": { + "type": "list", + "member": { + "target": "com.amazonaws.fsx#DeleteFileSystemOpenZFSOption" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } } }, "com.amazonaws.fsx#DeleteFileSystemOpenZFSResponse": { @@ -3311,7 +3349,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the Amazon FSx snapshot. After deletion, the snapshot no longer\n exists, and its data is gone. Deleting a snapshot doesn't affect snapshots stored in a\n file system backup.

\n

The DeleteSnapshot operation returns instantly. The snapshot appears with\n the lifecycle status of DELETING until the deletion is complete.

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

Deletes an Amazon FSx for OpenZFS snapshot. After deletion, the snapshot no longer\n exists, and its data is gone. Deleting a snapshot doesn't affect snapshots stored in a\n file system backup.

\n

The DeleteSnapshot operation returns instantly. The snapshot appears with\n the lifecycle status of DELETING until the deletion is complete.

", "smithy.api#idempotent": {} } }, @@ -3936,7 +3974,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the description of specific Amazon FSx snapshots, if a\n SnapshotIds value is provided. Otherwise, this operation returns all\n snapshots owned by your Amazon Web Services account in the Amazon Web Services Region of\n the endpoint that you're calling.

\n

When retrieving all snapshots, you can optionally specify the MaxResults\n parameter to limit the number of snapshots in a response. If more backups remain,\n Amazon FSx returns a NextToken value in the response. In this\n case, send a later request with the NextToken request parameter set to the\n value of NextToken from the last response.

\n

Use this operation in an iterative process to retrieve a list of your snapshots.\n DescribeSnapshots is called first without a NextToken\n value. Then the operation continues to be called with the NextToken\n parameter set to the value of the last NextToken value until a response has\n no NextToken value.

\n

When using this operation, keep the following in mind:

\n
    \n
  • \n

    The operation might return fewer than the MaxResults value of\n snapshot descriptions while still including a NextToken\n value.

    \n
    • \n
  • \n

    The order of snapshots returned in the response of one\n DescribeSnapshots call and the order of backups returned across\n the responses of a multi-call iteration is unspecified.

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

Returns the description of specific Amazon FSx for OpenZFS snapshots, if a\n SnapshotIds value is provided. Otherwise, this operation returns all\n snapshots owned by your Amazon Web Services account in the Amazon Web Services Region of\n the endpoint that you're calling.

\n

When retrieving all snapshots, you can optionally specify the MaxResults\n parameter to limit the number of snapshots in a response. If more backups remain,\n Amazon FSx returns a NextToken value in the response. In this\n case, send a later request with the NextToken request parameter set to the\n value of NextToken from the last response.

\n

Use this operation in an iterative process to retrieve a list of your snapshots.\n DescribeSnapshots is called first without a NextToken\n value. Then the operation continues to be called with the NextToken\n parameter set to the value of the last NextToken value until a response has\n no NextToken value.

\n

When using this operation, keep the following in mind:

\n
    \n
  • \n

    The operation might return fewer than the MaxResults value of\n snapshot descriptions while still including a NextToken\n value.

    \n
    • \n
  • \n

    The order of snapshots returned in the response of one\n DescribeSnapshots call and the order of backups returned across\n the responses of a multi-call iteration is unspecified.

    \n
    • \n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4813,6 +4851,26 @@ } } }, + "com.amazonaws.fsx#IntegerNoMaxFromNegativeOne": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": -1, + "max": 2147483647 + } + } + }, + "com.amazonaws.fsx#IntegerRecordSizeKiB": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 4, + "max": 1024 + } + } + }, "com.amazonaws.fsx#InternalServerError": { "type": "structure", "members": { @@ -5324,7 +5382,7 @@ "min": 1, "max": 4096 }, - "smithy.api#pattern": "^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{3,4096}$" + "smithy.api#pattern": "^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,4096}$" } }, "com.amazonaws.fsx#NetBiosAlias": { @@ -5432,7 +5490,7 @@ "EndpointIpAddressRange": { "target": "com.amazonaws.fsx#IpAddressRange", "traits": { - "smithy.api#documentation": "

The IP address range in which the endpoints to access your file system\n are created.

" + "smithy.api#documentation": "

The IP address range in which the endpoints to access your file system\n are created.

\n \n

The Endpoint IP address range you select for your file system\n must exist outside the VPC's CIDR range and must be at least /30 or larger.\n If you do not specify this optional parameter, Amazon FSx will automatically\n select a CIDR block for you.

\n " } }, "Endpoints": { @@ -5560,14 +5618,14 @@ "Clients": { "target": "com.amazonaws.fsx#OpenZFSClients", "traits": { - "smithy.api#documentation": "

A value that specifies who can mount the file system. You can provide a wildcard\n character (*), an IP address (0.0.0.0), or a CIDR address\n (192.0.2.0/24. By default, Amazon FSx uses the wildcard\n character when specifying the client.

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

A value that specifies who can mount the file system. You can provide a wildcard\n character (*), an IP address (0.0.0.0), or a CIDR address\n (192.0.2.0/24). By default, Amazon FSx uses the wildcard\n character when specifying the client.

", "smithy.api#required": {} } }, "Options": { "target": "com.amazonaws.fsx#OpenZFSNfsExportOptions", "traits": { - "smithy.api#documentation": "

The options to use when mounting the file system. For a list of options that you can\n use with Network File System (NFS), see the exports(5) - Linux man page. When\n choosing your options, consider the following:

\n
    \n
  • \n

    \n crossmount is used by default. If you don't specify\n crossmount when changing the client configuration, you won't be\n able to see or access snapshots in your file system's snapshot directory.

    \n
    • \n
  • \n

    \n sync is used by default. If you instead specify\n async, the system acknowledges writes before writing to disk.\n If the system crashes before the writes are finished, you lose the unwritten\n data.

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

The options to use when mounting the file system. For a list of options that you can\n use with Network File System (NFS), see the exports(5) - Linux man page. When\n choosing your options, consider the following:

\n
    \n
  • \n

    \n crossmnt is used by default. If you don't specify\n crossmnt when changing the client configuration, you won't be\n able to see or access snapshots in your file system's snapshot directory.

    \n
    • \n
  • \n

    \n sync is used by default. If you instead specify\n async, the system acknowledges writes before writing to disk.\n If the system crashes before the writes are finished, you lose the unwritten\n data.

    \n
    • \n
", "smithy.api#required": {} } } @@ -5616,10 +5674,16 @@ "com.amazonaws.fsx#OpenZFSCreateRootVolumeConfiguration": { "type": "structure", "members": { + "RecordSizeKiB": { + "target": "com.amazonaws.fsx#IntegerRecordSizeKiB", + "traits": { + "smithy.api#documentation": "

Specifies the record size of an OpenZFS root volume, in kibibytes (KiB). Valid values are 4, 8,\n 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the \n default record size. Database workflows can benefit from a smaller record size, while streaming \n workflows can benefit from a larger record size. For additional guidance on setting a custom record \n size, see \n Tips for maximizing performance in the\n Amazon FSx for OpenZFS User Guide.

" + } + }, "DataCompressionType": { "target": "com.amazonaws.fsx#OpenZFSDataCompressionType", "traits": { - "smithy.api#documentation": "

Specifies the method used to compress the data on the volume. Unless the compression\n type is specified, volumes inherit the DataCompressionType value of their\n parent volume.

\n
    \n
  • \n

    \n NONE - Doesn't compress the data on the volume.

    \n
    • \n
  • \n

    \n ZSTD - Compresses the data in the volume using the ZStandard\n (ZSTD) compression algorithm. This algorithm reduces the amount of space used on\n your volume and has very little impact on compute resources.

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

Specifies the method used to compress the data on the volume. The compression\n type is NONE by default.

\n
    \n
  • \n

    \n NONE - Doesn't compress the data on the volume.\n NONE is the default.

    \n
    • \n
  • \n

    \n ZSTD - Compresses the data in the volume using the Zstandard\n (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better\n compression ratio to minimize on-disk storage utilization.

    \n
    • \n
  • \n

    \n LZ4 - Compresses the data in the volume using the LZ4\n compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive\n and delivers higher write throughput speeds.

    \n
    • \n
" } }, "NfsExports": { @@ -5637,7 +5701,7 @@ "CopyTagsToSnapshots": { "target": "com.amazonaws.fsx#Flag", "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether tags for the volume should be copied to snapshots.\n This value defaults to false. If it's set to true, all tags\n for the volume are copied to snapshots where the user doesn't specify tags. If this\n value is true and you specify one or more tags, only the specified tags are\n copied to snapshots. If you specify one or more tags when creating the snapshot, no tags\n are copied from the volume, regardless of this value.

" + "smithy.api#documentation": "

A Boolean value indicating whether tags for the volume should be copied to snapshots\n of the volume. This value defaults to false. If it's set to true,\n all tags for the volume are copied to snapshots where the user doesn't specify tags. If this\n value is true and you specify one or more tags, only the specified tags are\n copied to snapshots. If you specify one or more tags when creating the snapshot, no tags\n are copied from the volume, regardless of this value.

" } }, "ReadOnly": { @@ -5662,6 +5726,10 @@ { "value": "ZSTD", "name": "ZSTD" + }, + { + "value": "LZ4", + "name": "LZ4" } ] } @@ -5707,7 +5775,7 @@ "ThroughputCapacity": { "target": "com.amazonaws.fsx#MegabytesPerSecond", "traits": { - "smithy.api#documentation": "

The throughput of an Amazon FSx file system, measured in megabytes per second\n (MBps), in 2 to the nth increments, between 2^3 (8) and 2^11 (2048).

" + "smithy.api#documentation": "

The throughput of an Amazon FSx file system, measured in megabytes per second\n (MBps). Valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MB/s.

" } }, "WeeklyMaintenanceStartTime": { @@ -5739,7 +5807,7 @@ } }, "traits": { - "smithy.api#documentation": "

The Network File System NFS) configurations for mounting an Amazon FSx for\n OpenZFS file system.

" + "smithy.api#documentation": "

The Network File System (NFS) configurations for mounting an Amazon FSx for\n OpenZFS file system.

" } }, "com.amazonaws.fsx#OpenZFSNfsExportOption": { @@ -5876,16 +5944,22 @@ "smithy.api#documentation": "

The maximum amount of storage in gibibtyes (GiB) that the volume can use from its\n parent. You can specify a quota larger than the storage on the parent volume.

" } }, + "RecordSizeKiB": { + "target": "com.amazonaws.fsx#IntegerRecordSizeKiB", + "traits": { + "smithy.api#documentation": "

The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8,\n 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB.\n Most workloads should use the default record size. For guidance on when\n to set a custom record size, see the\n Amazon FSx for OpenZFS User Guide.

" + } + }, "DataCompressionType": { "target": "com.amazonaws.fsx#OpenZFSDataCompressionType", "traits": { - "smithy.api#documentation": "

The method used to compress the data on the volume. Unless a compression type is\n specified, volumes inherit the DataCompressionType value of their parent\n volume.

\n
    \n
  • \n

    \n NONE - Doesn't compress the data on the volume.

    \n
    • \n
  • \n

    \n ZSTD - Compresses the data in the volume using the Zstandard\n (ZSTD) compression algorithm. This algorithm reduces the amount of space used on\n your volume and has very little impact on compute resources.

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

Specifies the method used to compress the data on the volume. The compression\n type is NONE by default.

\n
    \n
  • \n

    \n NONE - Doesn't compress the data on the volume.\n NONE is the default.

    \n
    • \n
  • \n

    \n ZSTD - Compresses the data in the volume using the Zstandard\n (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better\n compression ratio to minimize on-disk storage utilization.

    \n
    • \n
  • \n

    \n LZ4 - Compresses the data in the volume using the LZ4\n compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive\n and delivers higher write throughput speeds.

    \n
    • \n
" } }, "CopyTagsToSnapshots": { "target": "com.amazonaws.fsx#Flag", "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether tags for the volume should be copied to snapshots.\n This value defaults to false. If it's set to true, all tags\n for the volume are copied to snapshots where the user doesn't specify tags. If this\n value is true and you specify one or more tags, only the specified tags are\n copied to snapshots. If you specify one or more tags when creating the snapshot, no tags\n are copied from the volume, regardless of this value.

" + "smithy.api#documentation": "

A Boolean value indicating whether tags for the volume should be copied to snapshots.\n This value defaults to false. If it's set to true, all tags\n for the volume are copied to snapshots where the user doesn't specify tags. If this\n value is true and you specify one or more tags, only the specified tags are\n copied to snapshots. If you specify one or more tags when creating the snapshot, no tags\n are copied from the volume, regardless of this value.

" } }, "OriginSnapshot": { @@ -5903,13 +5977,13 @@ "NfsExports": { "target": "com.amazonaws.fsx#OpenZFSNfsExports", "traits": { - "smithy.api#documentation": "

The configuration object for mounting a Network File System (NFS) file\n system.

" + "smithy.api#documentation": "

The configuration object for mounting a Network File System (NFS)\n file system.

" } }, "UserAndGroupQuotas": { "target": "com.amazonaws.fsx#OpenZFSUserAndGroupQuotas", "traits": { - "smithy.api#documentation": "

An object specifying how much storage users or groups can use on the volume.

" + "smithy.api#documentation": "

An object specifying how much storage users or groups can use on the volume.

" } } }, @@ -6509,6 +6583,9 @@ "smithy.api#documentation": "

The lifecycle status of the snapshot.

\n
    \n
  • \n

    \n PENDING - Amazon FSx hasn't started creating the\n snapshot.

    \n
    • \n
  • \n

    \n CREATING - Amazon FSx is creating the snapshot.

    \n
    • \n
  • \n

    \n DELETING - Amazon FSx is deleting the snapshot.

    \n
    • \n
  • \n

    \n AVAILABLE - The snapshot is fully available.

    \n
    • \n
" } }, + "LifecycleTransitionReason": { + "target": "com.amazonaws.fsx#LifecycleTransitionReason" + }, "Tags": { "target": "com.amazonaws.fsx#Tags" }, @@ -6963,7 +7040,7 @@ } }, "traits": { - "smithy.api#documentation": "

No Amazon FSx for NetApp ONTAP SVMs were found based upon the supplied parameters.

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

No FSx for ONTAP SVMs were found based upon the supplied parameters.

", "smithy.api#error": "client" } }, @@ -7580,13 +7657,13 @@ "CopyTagsToBackups": { "target": "com.amazonaws.fsx#Flag", "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether tags for the file system should be copied to\n backups. This value defaults to false. If it's set to true,\n all tags for the file system are copied to all automatic and user-initiated backups\n where the user doesn't specify tags. If this value is true and you specify\n one or more tags, only the specified tags are copied to backups. If you specify one or\n more tags when creating a user-initiated backup, no tags are copied from the file\n system, regardless of this value.

" + "smithy.api#documentation": "

A Boolean value indicating whether tags for the file system should be copied to\n backups. This value defaults to false. If it's set to true,\n all tags for the file system are copied to all automatic and user-initiated backups\n where the user doesn't specify tags. If this value is true and you specify\n one or more tags, only the specified tags are copied to backups. If you specify one or\n more tags when creating a user-initiated backup, no tags are copied from the file\n system, regardless of this value.

" } }, "CopyTagsToVolumes": { "target": "com.amazonaws.fsx#Flag", "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether tags for the volume should be copied to snapshots.\n This value defaults to false. If it's set to true, all tags\n for the volume are copied to snapshots where the user doesn't specify tags. If this\n value is true and you specify one or more tags, only the specified tags are\n copied to snapshots. If you specify one or more tags when creating the snapshot, no tags\n are copied from the volume, regardless of this value.

" + "smithy.api#documentation": "

A Boolean value indicating whether tags for the volume should be copied to snapshots.\n This value defaults to false. If it's set to true, all tags\n for the volume are copied to snapshots where the user doesn't specify tags. If this\n value is true and you specify one or more tags, only the specified tags are\n copied to snapshots. If you specify one or more tags when creating the snapshot, no tags\n are copied from the volume, regardless of this value.

" } }, "DailyAutomaticBackupStartTime": { @@ -7595,7 +7672,7 @@ "ThroughputCapacity": { "target": "com.amazonaws.fsx#MegabytesPerSecond", "traits": { - "smithy.api#documentation": "

The throughput of an Amazon FSx file system, measured in megabytes per second\n (MBps), in 2 to the nth increments, between 2^3 (8) and 2^12 (4096).

" + "smithy.api#documentation": "

The throughput of an Amazon FSx file system, measured in megabytes per second\n (MBps). Valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MB/s.

" } }, "WeeklyMaintenanceStartTime": { @@ -7755,21 +7832,27 @@ "type": "structure", "members": { "StorageCapacityReservationGiB": { - "target": "com.amazonaws.fsx#IntegerNoMax", + "target": "com.amazonaws.fsx#IntegerNoMaxFromNegativeOne", "traits": { - "smithy.api#documentation": "

The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't\n reserve more storage than the parent volume has reserved.

" + "smithy.api#documentation": "

The amount of storage in gibibytes (GiB) to reserve from the parent volume.\n You can't reserve more storage than the parent volume has reserved. You can specify\n a value of -1 to unset a volume's storage capacity reservation.

" } }, "StorageCapacityQuotaGiB": { - "target": "com.amazonaws.fsx#IntegerNoMax", + "target": "com.amazonaws.fsx#IntegerNoMaxFromNegativeOne", + "traits": { + "smithy.api#documentation": "

The maximum amount of storage in gibibytes (GiB) that the volume can use from its\n parent. You can specify a quota larger than the storage on the parent volume. You\n can specify a value of -1 to unset a volume's storage capacity quota.

" + } + }, + "RecordSizeKiB": { + "target": "com.amazonaws.fsx#IntegerRecordSizeKiB", "traits": { - "smithy.api#documentation": "

\n

The maximum amount of storage in gibibytes (GiB) that the volume can use from its\n parent. You can specify a quota larger than the storage on the parent volume.

" + "smithy.api#documentation": "

Specifies the record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8,\n 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB.\n Most workloads should use the default record size. Database workflows can benefit from a smaller \n record size, while streaming workflows can benefit from a larger record size. For additional guidance on when\n to set a custom record size, see \n Tips for maximizing performance in the\n Amazon FSx for OpenZFS User Guide.

" } }, "DataCompressionType": { "target": "com.amazonaws.fsx#OpenZFSDataCompressionType", "traits": { - "smithy.api#documentation": "

\n

Specifies the method used to compress the data on the volume. Unless the compression\n type is specified, volumes inherit the DataCompressionType value of their\n parent volume.

\n
    \n
  • \n

    \n NONE - Doesn't compress the data on the volume.

    \n
    • \n
  • \n

    \n ZSTD - Compresses the data in the volume using the Zstandard\n (ZSTD) compression algorithm. This algorithm reduces the amount of space used on\n your volume and has very little impact on compute resources.

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

Specifies the method used to compress the data on the volume. The compression\n type is NONE by default.

\n
    \n
  • \n

    \n NONE - Doesn't compress the data on the volume.\n NONE is the default.

    \n
    • \n
  • \n

    \n ZSTD - Compresses the data in the volume using the Zstandard\n (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better\n compression ratio to minimize on-disk storage utilization.

    \n
    • \n
  • \n

    \n LZ4 - Compresses the data in the volume using the LZ4\n compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive\n and delivers higher write throughput speeds.

    \n
    • \n
" } }, "NfsExports": { @@ -7792,7 +7875,7 @@ } }, "traits": { - "smithy.api#documentation": "

Used to specify changes to the OpenZFS configuration for the volume that you are\n updating.

" + "smithy.api#documentation": "

Used to specify changes to the OpenZFS configuration for the volume\n that you are updating.

" } }, "com.amazonaws.fsx#UpdateSnapshot": { @@ -7815,7 +7898,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the name of a snapshot.

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

Updates the name of an Amazon FSx for OpenZFS snapshot.

", "smithy.api#idempotent": {} } }, @@ -7831,7 +7914,7 @@ "Name": { "target": "com.amazonaws.fsx#SnapshotName", "traits": { - "smithy.api#documentation": "

The name of the snapshot to update.

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

The name of the snapshot to update.

", "smithy.api#required": {} } }, @@ -8228,7 +8311,7 @@ } }, "traits": { - "smithy.api#documentation": "

No Amazon FSx for NetApp ONTAP volumes were found based upon the supplied parameters.

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

No Amazon FSx volumes were found based upon the supplied parameters.

", "smithy.api#error": "client" } }, diff --git a/aws/sdk/aws-models/gamelift.json b/aws/sdk/aws-models/gamelift.json index f9a27e38b3..51bf6b0372 100644 --- a/aws/sdk/aws-models/gamelift.json +++ b/aws/sdk/aws-models/gamelift.json @@ -2676,7 +2676,7 @@ } ], "traits": { - "smithy.api#documentation": "

The GameLift service limits and current utilization for an Amazon Web Services Region or location.\n Instance limits control the number of instances, per instance type, per location, that\n your Amazon Web Services account can use. Learn more at Amazon EC2 Instance Types. The information\n returned includes the maximum number of instances allowed and your account's current\n usage across all fleets. This information can affect your ability to scale your GameLift\n fleets. You can request a limit increase for your account by using the Service limits page in the GameLift console.

\n

Instance limits differ based on whether the instances are deployed in a fleet's home\n Region or in a remote location. For remote locations, limits also differ based on the\n combination of home Region and remote location. All requests must specify an Amazon Web Services Region\n (either explicitly or as your default settings). To get the limit for a remote location,\n you must also specify the location. For example, the following requests all return\n different results:

\n
    \n
  • \n

    Request specifies the Region ap-northeast-1 with no location. The\n result is limits and usage data on all instance types that are deployed in\n us-east-2, by all of the fleets that reside in\n ap-northeast-1.

    \n
    • \n
  • \n

    Request specifies the Region us-east-1 with location\n ca-central-1. The result is limits and usage data on all\n instance types that are deployed in ca-central-1, by all of the\n fleets that reside in us-east-2. These limits do not affect fleets\n in any other Regions that deploy instances to ca-central-1.

    \n
    • \n
  • \n

    Request specifies the Region eu-west-1 with location\n ca-central-1. The result is limits and usage data on all\n instance types that are deployed in ca-central-1, by all of the\n fleets that reside in eu-west-1.

    \n
    • \n
\n

This operation can be used in the following ways:

\n
    \n
  • \n

    To get limit and usage data for all instance types that are deployed in an Amazon Web Services\n Region by fleets that reside in the same Region: Specify the Region only.\n Optionally, specify a single instance type to retrieve information for.

    \n
    • \n
  • \n

    To get limit and usage data for all instance types that are deployed to a\n remote location by fleets that reside in different Amazon Web Services Region: Provide both the\n Amazon Web Services Region and the remote location. Optionally, specify a single instance type\n to retrieve information for.

    \n
    • \n
\n

If successful, an EC2InstanceLimits object is returned with limits and\n usage data for each requested instance type.

\n

\n Learn more\n

\n

\n Setting up GameLift fleets\n

\n \n

\n Related actions\n

\n

\n CreateFleet | \n UpdateFleetCapacity | \n PutScalingPolicy | \n DescribeEC2InstanceLimits | \n DescribeFleetAttributes | \n DescribeFleetLocationAttributes | \n UpdateFleetAttributes | \n StopFleetActions | \n DeleteFleet | \n All APIs by task\n

" + "smithy.api#documentation": "

Retrieves the instance limits and current utilization for an Amazon Web Services Region or location.\n Instance limits control the number of instances, per instance type, per location, that\n your Amazon Web Services account can use. Learn more at Amazon EC2 Instance Types. The information\n returned includes the maximum number of instances allowed and your account's current\n usage across all fleets. This information can affect your ability to scale your GameLift\n fleets. You can request a limit increase for your account by using the Service limits page in the GameLift console.

\n

Instance limits differ based on whether the instances are deployed in a fleet's home\n Region or in a remote location. For remote locations, limits also differ based on the\n combination of home Region and remote location. All requests must specify an Amazon Web Services Region\n (either explicitly or as your default settings). To get the limit for a remote location,\n you must also specify the location. For example, the following requests all return\n different results:

\n
    \n
  • \n

    Request specifies the Region ap-northeast-1 with no location. The\n result is limits and usage data on all instance types that are deployed in\n us-east-2, by all of the fleets that reside in\n ap-northeast-1.

    \n
    • \n
  • \n

    Request specifies the Region us-east-1 with location\n ca-central-1. The result is limits and usage data on all\n instance types that are deployed in ca-central-1, by all of the\n fleets that reside in us-east-2. These limits do not affect fleets\n in any other Regions that deploy instances to ca-central-1.

    \n
    • \n
  • \n

    Request specifies the Region eu-west-1 with location\n ca-central-1. The result is limits and usage data on all\n instance types that are deployed in ca-central-1, by all of the\n fleets that reside in eu-west-1.

    \n
    • \n
\n

This operation can be used in the following ways:

\n
    \n
  • \n

    To get limit and usage data for all instance types that are deployed in an Amazon Web Services\n Region by fleets that reside in the same Region: Specify the Region only.\n Optionally, specify a single instance type to retrieve information for.

    \n
    • \n
  • \n

    To get limit and usage data for all instance types that are deployed to a\n remote location by fleets that reside in different Amazon Web Services Region: Provide both the\n Amazon Web Services Region and the remote location. Optionally, specify a single instance type\n to retrieve information for.

    \n
    • \n
\n

If successful, an EC2InstanceLimits object is returned with limits and\n usage data for each requested instance type.

\n

\n Learn more\n

\n

\n Setting up GameLift fleets\n

\n \n

\n Related actions\n

\n

\n CreateFleet | \n UpdateFleetCapacity | \n PutScalingPolicy | \n DescribeEC2InstanceLimits | \n DescribeFleetAttributes | \n DescribeFleetLocationAttributes | \n UpdateFleetAttributes | \n StopFleetActions | \n DeleteFleet | \n All APIs by task\n

" } }, "com.amazonaws.gamelift#DescribeEC2InstanceLimitsInput": { @@ -3990,7 +3990,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket\n information, including--after a successful match is made--connection information for the\n resulting new game session.

\n

To request matchmaking tickets, provide a list of up to 10 ticket IDs. If the\n request is successful, a ticket object is returned for each requested ID that currently\n exists.

\n

This operation is not designed to be continually called to track matchmaking ticket\n status. This practice can cause you to exceed your API limit, which results in errors.\n Instead, as a best practice, set up an Amazon Simple Notification Service to receive notifications, and provide\n the topic ARN in the matchmaking configuration. Continuously poling ticket status with\n DescribeMatchmaking should only be used for games in development\n with low matchmaking usage.

\n

\n

\n Learn more\n

\n

\n \n Add FlexMatch to a game client\n

\n

\n \n Set Up FlexMatch event notification\n

\n

\n Related actions\n

\n

\n StartMatchmaking | \n DescribeMatchmaking | \n StopMatchmaking | \n AcceptMatch | \n StartMatchBackfill | \n All APIs by task\n

" + "smithy.api#documentation": "

Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket\n information, including--after a successful match is made--connection information for the\n resulting new game session.

\n

To request matchmaking tickets, provide a list of up to 10 ticket IDs. If the\n request is successful, a ticket object is returned for each requested ID that currently\n exists.

\n

This operation is not designed to be continually called to track matchmaking ticket\n status. This practice can cause you to exceed your API limit, which results in errors.\n Instead, as a best practice, set up an Amazon Simple Notification Service to receive notifications, and provide\n the topic ARN in the matchmaking configuration. Continuously polling ticket status with\n DescribeMatchmaking should only be used for games in development\n with low matchmaking usage.

\n

\n

\n Learn more\n

\n

\n \n Add FlexMatch to a game client\n

\n

\n \n Set Up FlexMatch event notification\n

\n

\n Related actions\n

\n

\n StartMatchmaking | \n DescribeMatchmaking | \n StopMatchmaking | \n AcceptMatch | \n StartMatchBackfill | \n All APIs by task\n

" } }, "com.amazonaws.gamelift#DescribeMatchmakingConfigurations": { diff --git a/aws/sdk/aws-models/greengrassv2.json b/aws/sdk/aws-models/greengrassv2.json index 4305dcc48d..be66032692 100644 --- a/aws/sdk/aws-models/greengrassv2.json +++ b/aws/sdk/aws-models/greengrassv2.json @@ -1101,7 +1101,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a continuous deployment for a target, which is a Greengrass core device or group of core\n devices. When you add a new core device to a group of core devices that has a deployment, IoT Greengrass\n deploys that group's deployment to the new device.

\n

You can define one deployment for each target. When you create a new deployment for a\n target that has an existing deployment, you replace the previous deployment. IoT Greengrass applies the\n new deployment to the target devices.

\n

Every deployment has a revision number that indicates how many deployment revisions you\n define for a target. Use this operation to create a new revision of an existing deployment.\n This operation returns the revision number of the new deployment when you create it.

\n

For more information, see the Create deployments in the\n IoT Greengrass V2 Developer Guide.

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

Creates a continuous deployment for a target, which is a Greengrass core device or group of core\n devices. When you add a new core device to a group of core devices that has a deployment, IoT Greengrass\n deploys that group's deployment to the new device.

\n

You can define one deployment for each target. When you create a new deployment for a\n target that has an existing deployment, you replace the previous deployment. IoT Greengrass applies the\n new deployment to the target devices.

\n

Every deployment has a revision number that indicates how many deployment revisions you\n define for a target. Use this operation to create a new revision of an existing\n deployment.

\n

For more information, see the Create deployments in the\n IoT Greengrass V2 Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/greengrass/v2/deployments", @@ -2023,7 +2023,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves connectivity information for a Greengrass core device.

\n

Connectivity information includes endpoints and ports where client devices\n can connect to an MQTT broker on the core device. When a client device\n calls the Greengrass discovery API,\n IoT Greengrass returns connectivity information for all of the core devices where the client device can\n connect. For more information, see Connect client devices to\n core devices in the IoT Greengrass Version 2 Developer Guide.

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

Retrieves connectivity information for a Greengrass core device.

\n

Connectivity information includes endpoints and ports where client devices\n can connect to an MQTT broker on the core device. When a client device\n calls the IoT Greengrass discovery API,\n IoT Greengrass returns connectivity information for all of the core devices where the client device can\n connect. For more information, see Connect client devices to\n core devices in the IoT Greengrass Version 2 Developer Guide.

", "smithy.api#http": { "method": "GET", "uri": "/greengrass/things/{thingName}/connectivityInfo", @@ -4347,7 +4347,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates connectivity information for a Greengrass core device.

\n

Connectivity information includes endpoints and ports where client devices\n can connect to an MQTT broker on the core device. When a client device\n calls the Greengrass discovery API,\n IoT Greengrass returns connectivity information for all of the core devices where the client device can\n connect. For more information, see Connect client devices to\n core devices in the IoT Greengrass Version 2 Developer Guide.

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

Updates connectivity information for a Greengrass core device.

\n

Connectivity information includes endpoints and ports where client devices\n can connect to an MQTT broker on the core device. When a client device\n calls the IoT Greengrass discovery API,\n IoT Greengrass returns connectivity information for all of the core devices where the client device can\n connect. For more information, see Connect client devices to\n core devices in the IoT Greengrass Version 2 Developer Guide.

", "smithy.api#http": { "method": "PUT", "uri": "/greengrass/things/{thingName}/connectivityInfo", diff --git a/aws/sdk/aws-models/kafkaconnect.json b/aws/sdk/aws-models/kafkaconnect.json index 8d2cedfc14..54e0708bb7 100644 --- a/aws/sdk/aws-models/kafkaconnect.json +++ b/aws/sdk/aws-models/kafkaconnect.json @@ -14,7 +14,7 @@ "vpc": { "target": "com.amazonaws.kafkaconnect#Vpc", "traits": { - "smithy.api#documentation": "

Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.

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

Details of an Amazon VPC which has network connectivity to the Apache Kafka\n cluster.

", "smithy.api#required": {} } } @@ -35,7 +35,7 @@ "vpc": { "target": "com.amazonaws.kafkaconnect#VpcDescription", "traits": { - "smithy.api#documentation": "

Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.

" + "smithy.api#documentation": "

Details of an Amazon VPC which has network connectivity to the Apache Kafka\n cluster.

" } } }, @@ -56,7 +56,7 @@ "mcuCount": { "target": "com.amazonaws.kafkaconnect#__integerMin1Max8", "traits": { - "smithy.api#documentation": "

The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.

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

The number of microcontroller units (MCUs) allocated to each connector worker. The valid\n values are 1,2,4,8.

", "smithy.api#required": {} } }, @@ -96,7 +96,7 @@ "mcuCount": { "target": "com.amazonaws.kafkaconnect#__integer", "traits": { - "smithy.api#documentation": "

The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.

" + "smithy.api#documentation": "

The number of microcontroller units (MCUs) allocated to each connector worker. The valid\n values are 1,2,4,8.

" } }, "minWorkerCount": { @@ -135,7 +135,7 @@ "mcuCount": { "target": "com.amazonaws.kafkaconnect#__integerMin1Max8", "traits": { - "smithy.api#documentation": "

The target number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.

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

The target number of microcontroller units (MCUs) allocated to each connector worker.\n The valid values are 1,2,4,8.

", "smithy.api#required": {} } }, @@ -173,7 +173,7 @@ } }, "traits": { - "smithy.api#documentation": "

HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.

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

HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then\n retry it.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -195,7 +195,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information about the capacity of the connector, whether it is auto scaled or provisioned.

" + "smithy.api#documentation": "

Information about the capacity of the connector, whether it is auto scaled or\n provisioned.

" } }, "com.amazonaws.kafkaconnect#CapacityDescription": { @@ -235,7 +235,7 @@ } }, "traits": { - "smithy.api#documentation": "

The target capacity for the connector. The capacity can be auto scaled or provisioned.

" + "smithy.api#documentation": "

The target capacity for the connector. The capacity can be auto scaled or\n provisioned.

" } }, "com.amazonaws.kafkaconnect#CloudWatchLogsLogDelivery": { @@ -287,7 +287,7 @@ } }, "traits": { - "smithy.api#documentation": "

HTTP Status Code 409: Conflict. A resource with this name already exists. Retry your request with another name.

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

HTTP Status Code 409: Conflict. A resource with this name already exists. Retry your\n request with another name.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -373,7 +373,7 @@ "kafkaClusterClientAuthentication": { "target": "com.amazonaws.kafkaconnect#KafkaClusterClientAuthenticationDescription", "traits": { - "smithy.api#documentation": "

The type of client authentication used to connect to the Apache Kafka cluster. The value is NONE when no client authentication is used.

" + "smithy.api#documentation": "

The type of client authentication used to connect to the Apache Kafka cluster. The value\n is NONE when no client authentication is used.

" } }, "kafkaClusterEncryptionInTransit": { @@ -385,7 +385,7 @@ "kafkaConnectVersion": { "target": "com.amazonaws.kafkaconnect#__string", "traits": { - "smithy.api#documentation": "

The version of Kafka Connect. It has to be compatible with both the Apache Kafka cluster's version and the plugins.

" + "smithy.api#documentation": "

The version of Kafka Connect. It has to be compatible with both the Apache Kafka\n cluster's version and the plugins.

" } }, "logDelivery": { @@ -403,7 +403,7 @@ "serviceExecutionRoleArn": { "target": "com.amazonaws.kafkaconnect#__string", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon\n Web Services resources.

" } }, "workerConfiguration": { @@ -466,7 +466,7 @@ "capacity": { "target": "com.amazonaws.kafkaconnect#Capacity", "traits": { - "smithy.api#documentation": "

Information about the capacity allocated to the connector. Exactly one of the two properties must be specified.

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

Information about the capacity allocated to the connector. Exactly one of the two\n properties must be specified.

", "smithy.api#required": {} } }, @@ -474,7 +474,8 @@ "target": "com.amazonaws.kafkaconnect#__mapOf__string", "traits": { "smithy.api#documentation": "

A map of keys to values that represent the configuration for the connector.

", - "smithy.api#required": {} + "smithy.api#required": {}, + "smithy.api#sensitive": {} } }, "connectorDescription": { @@ -514,7 +515,7 @@ "kafkaConnectVersion": { "target": "com.amazonaws.kafkaconnect#__string", "traits": { - "smithy.api#documentation": "

The version of Kafka Connect. It has to be compatible with both the Apache Kafka cluster's version and the plugins.

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

The version of Kafka Connect. It has to be compatible with both the Apache Kafka\n cluster's version and the plugins.

", "smithy.api#required": {} } }, @@ -534,7 +535,7 @@ "serviceExecutionRoleArn": { "target": "com.amazonaws.kafkaconnect#__string", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role used by the connector to access the Amazon Web Services resources that it needs. The types of resources depends on the logic of the connector. For example, a connector that has Amazon S3 as a destination must have permissions that allow it to write to the S3 destination bucket.

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

The Amazon Resource Name (ARN) of the IAM role used by the connector to access the\n Amazon Web Services resources that it needs. The types of resources depends on the logic of\n the connector. For example, a connector that has Amazon S3 as a destination must have\n permissions that allow it to write to the S3 destination bucket.

", "smithy.api#required": {} } }, @@ -736,7 +737,8 @@ "target": "com.amazonaws.kafkaconnect#__string", "traits": { "smithy.api#documentation": "

Base64 encoded contents of connect-distributed.properties file.

", - "smithy.api#required": {} + "smithy.api#required": {}, + "smithy.api#sensitive": {} } } } @@ -789,7 +791,7 @@ } }, "traits": { - "smithy.api#documentation": "

A plugin is an AWS resource that contains the code that defines a connector's logic.

" + "smithy.api#documentation": "

A plugin is an AWS resource that contains the code that defines a connector's\n logic.

" } }, "com.amazonaws.kafkaconnect#CustomPluginContentType": { @@ -833,7 +835,7 @@ "fileMd5": { "target": "com.amazonaws.kafkaconnect#__string", "traits": { - "smithy.api#documentation": "

The hex-encoded MD5 checksum of the custom plugin file. You can use it to validate the file.

" + "smithy.api#documentation": "

The hex-encoded MD5 checksum of the custom plugin file. You can use it to validate the\n file.

" } }, "fileSize": { @@ -853,7 +855,7 @@ "s3Location": { "target": "com.amazonaws.kafkaconnect#S3Location", "traits": { - "smithy.api#documentation": "

The S3 bucket Amazon Resource Name (ARN), file key, and object version of the plugin file stored in Amazon S3.

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

The S3 bucket Amazon Resource Name (ARN), file key, and object version of the plugin\n file stored in Amazon S3.

", "smithy.api#required": {} } } @@ -868,7 +870,7 @@ "s3Location": { "target": "com.amazonaws.kafkaconnect#S3LocationDescription", "traits": { - "smithy.api#documentation": "

The S3 bucket Amazon Resource Name (ARN), file key, and object version of the plugin file stored in Amazon S3.

" + "smithy.api#documentation": "

The S3 bucket Amazon Resource Name (ARN), file key, and object version of the plugin\n file stored in Amazon S3.

" } } }, @@ -1073,6 +1075,77 @@ } } }, + "com.amazonaws.kafkaconnect#DeleteCustomPlugin": { + "type": "operation", + "input": { + "target": "com.amazonaws.kafkaconnect#DeleteCustomPluginRequest" + }, + "output": { + "target": "com.amazonaws.kafkaconnect#DeleteCustomPluginResponse" + }, + "errors": [ + { + "target": "com.amazonaws.kafkaconnect#BadRequestException" + }, + { + "target": "com.amazonaws.kafkaconnect#ForbiddenException" + }, + { + "target": "com.amazonaws.kafkaconnect#InternalServerErrorException" + }, + { + "target": "com.amazonaws.kafkaconnect#NotFoundException" + }, + { + "target": "com.amazonaws.kafkaconnect#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.kafkaconnect#TooManyRequestsException" + }, + { + "target": "com.amazonaws.kafkaconnect#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a custom plugin.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v1/custom-plugins/{customPluginArn}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.kafkaconnect#DeleteCustomPluginRequest": { + "type": "structure", + "members": { + "customPluginArn": { + "target": "com.amazonaws.kafkaconnect#__string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom plugin that you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.kafkaconnect#DeleteCustomPluginResponse": { + "type": "structure", + "members": { + "customPluginArn": { + "target": "com.amazonaws.kafkaconnect#__string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom plugin that you requested to delete.

" + } + }, + "customPluginState": { + "target": "com.amazonaws.kafkaconnect#CustomPluginState", + "traits": { + "smithy.api#documentation": "

The state of the custom plugin.

" + } + } + } + }, "com.amazonaws.kafkaconnect#DescribeConnector": { "type": "operation", "input": { @@ -1133,7 +1206,7 @@ "capacity": { "target": "com.amazonaws.kafkaconnect#CapacityDescription", "traits": { - "smithy.api#documentation": "

Information about the capacity of the connector, whether it is auto scaled or provisioned.

" + "smithy.api#documentation": "

Information about the capacity of the connector, whether it is auto scaled or\n provisioned.

" } }, "connectorArn": { @@ -1145,7 +1218,8 @@ "connectorConfiguration": { "target": "com.amazonaws.kafkaconnect#__mapOf__string", "traits": { - "smithy.api#documentation": "

A map of keys to values that represent the configuration for the connector.

" + "smithy.api#documentation": "

A map of keys to values that represent the configuration for the connector.

", + "smithy.api#sensitive": {} } }, "connectorDescription": { @@ -1187,7 +1261,7 @@ "kafkaClusterClientAuthentication": { "target": "com.amazonaws.kafkaconnect#KafkaClusterClientAuthenticationDescription", "traits": { - "smithy.api#documentation": "

The type of client authentication used to connect to the Apache Kafka cluster. The value is NONE when no client authentication is used.

" + "smithy.api#documentation": "

The type of client authentication used to connect to the Apache Kafka cluster. The value\n is NONE when no client authentication is used.

" } }, "kafkaClusterEncryptionInTransit": { @@ -1199,7 +1273,7 @@ "kafkaConnectVersion": { "target": "com.amazonaws.kafkaconnect#__string", "traits": { - "smithy.api#documentation": "

The version of Kafka Connect. It has to be compatible with both the Apache Kafka cluster's version and the plugins.

" + "smithy.api#documentation": "

The version of Kafka Connect. It has to be compatible with both the Apache Kafka\n cluster's version and the plugins.

" } }, "logDelivery": { @@ -1217,7 +1291,7 @@ "serviceExecutionRoleArn": { "target": "com.amazonaws.kafkaconnect#__string", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon\n Web Services resources.

" } }, "workerConfiguration": { @@ -1225,6 +1299,12 @@ "traits": { "smithy.api#documentation": "

Specifies which worker configuration was used for the connector.

" } + }, + "stateDescription": { + "target": "com.amazonaws.kafkaconnect#StateDescription", + "traits": { + "smithy.api#documentation": "

Details about the state of a connector.

" + } } } }, @@ -1312,7 +1392,7 @@ "latestRevision": { "target": "com.amazonaws.kafkaconnect#CustomPluginRevisionSummary", "traits": { - "smithy.api#documentation": "

The latest successfully created revision of the custom plugin. If there are no successfully created revisions, this field will be absent.

" + "smithy.api#documentation": "

The latest successfully created revision of the custom plugin. If there are no\n successfully created revisions, this field will be absent.

" } }, "name": { @@ -1320,6 +1400,12 @@ "traits": { "smithy.api#documentation": "

The name of the custom plugin.

" } + }, + "stateDescription": { + "target": "com.amazonaws.kafkaconnect#StateDescription", + "traits": { + "smithy.api#documentation": "

Details about the state of a custom plugin.

" + } } } }, @@ -1370,7 +1456,7 @@ "workerConfigurationArn": { "target": "com.amazonaws.kafkaconnect#__string", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the worker configuration that you want to get information about.

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

The Amazon Resource Name (ARN) of the worker configuration that you want to get\n information about.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1418,7 +1504,7 @@ "deliveryStream": { "target": "com.amazonaws.kafkaconnect#__string", "traits": { - "smithy.api#documentation": "

The name of the Kinesis Data Firehose delivery stream that is the destination for log delivery.

" + "smithy.api#documentation": "

The name of the Kinesis Data Firehose delivery stream that is the destination for log\n delivery.

" } }, "enabled": { @@ -1439,7 +1525,7 @@ "deliveryStream": { "target": "com.amazonaws.kafkaconnect#__string", "traits": { - "smithy.api#documentation": "

The name of the Kinesis Data Firehose delivery stream that is the destination for log delivery.

" + "smithy.api#documentation": "

The name of the Kinesis Data Firehose delivery stream that is the destination for log\n delivery.

" } }, "enabled": { @@ -1450,7 +1536,7 @@ } }, "traits": { - "smithy.api#documentation": "

A description of the settings for delivering logs to Amazon Kinesis Data Firehose.

" + "smithy.api#documentation": "

A description of the settings for delivering logs to Amazon Kinesis Data\n Firehose.

" } }, "com.amazonaws.kafkaconnect#ForbiddenException": { @@ -1461,7 +1547,7 @@ } }, "traits": { - "smithy.api#documentation": "

HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.

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

HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your\n request.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -1474,7 +1560,7 @@ } }, "traits": { - "smithy.api#documentation": "

HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

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

HTTP Status Code 500: Unexpected internal server error. Retrying your request might\n resolve the issue.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -1500,13 +1586,13 @@ "authenticationType": { "target": "com.amazonaws.kafkaconnect#KafkaClusterClientAuthenticationType", "traits": { - "smithy.api#documentation": "

The type of client authentication used to connect to the Apache Kafka cluster. Value NONE means that no client authentication is used.

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

The type of client authentication used to connect to the Apache Kafka cluster. Value\n NONE means that no client authentication is used.

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

The client authentication information used in order to authenticate with the Apache Kafka cluster.

" + "smithy.api#documentation": "

The client authentication information used in order to authenticate with the Apache\n Kafka cluster.

" } }, "com.amazonaws.kafkaconnect#KafkaClusterClientAuthenticationDescription": { @@ -1515,12 +1601,12 @@ "authenticationType": { "target": "com.amazonaws.kafkaconnect#KafkaClusterClientAuthenticationType", "traits": { - "smithy.api#documentation": "

The type of client authentication used to connect to the Apache Kafka cluster. Value NONE means that no client authentication is used.

" + "smithy.api#documentation": "

The type of client authentication used to connect to the Apache Kafka cluster. Value\n NONE means that no client authentication is used.

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

The client authentication information used in order to authenticate with the Apache Kafka cluster.

" + "smithy.api#documentation": "

The client authentication information used in order to authenticate with the Apache\n Kafka cluster.

" } }, "com.amazonaws.kafkaconnect#KafkaClusterClientAuthenticationType": { @@ -1598,6 +1684,29 @@ }, "com.amazonaws.kafkaconnect#KafkaConnect": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "KafkaConnect", + "name": "kafkaconnect", + "arnNamespace": "kafkaconnect", + "cloudFormationName": "KafkaConnect", + "cloudTrailEventSource": "kafkaconnect.amazonaws.com", + "endpointPrefix": "kafkaconnect" + }, + "aws.auth#sigv4": { + "name": "kafkaconnect" + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "X-Api-Key", + "Content-Type", + "Content-Length" + ] + }, + "smithy.api#documentation": "

", + "smithy.api#title": "Managed Streaming for Kafka Connect" + }, "version": "2021-09-14", "operations": [ { @@ -1612,6 +1721,9 @@ { "target": "com.amazonaws.kafkaconnect#DeleteConnector" }, + { + "target": "com.amazonaws.kafkaconnect#DeleteCustomPlugin" + }, { "target": "com.amazonaws.kafkaconnect#DescribeConnector" }, @@ -1633,27 +1745,7 @@ { "target": "com.amazonaws.kafkaconnect#UpdateConnector" } - ], - "traits": { - "aws.api#service": { - "sdkId": "KafkaConnect", - "arnNamespace": "kafkaconnect", - "cloudFormationName": "KafkaConnect", - "cloudTrailEventSource": "kafkaconnect.amazonaws.com", - "endpointPrefix": "kafkaconnect" - }, - "aws.auth#sigv4": { - "name": "kafkaconnect" - }, - "aws.protocols#restJson1": {}, - "smithy.api#cors": { - "additionalAllowedHeaders": [ - "X-Api-Key" - ] - }, - "smithy.api#documentation": "

", - "smithy.api#title": "Managed Streaming for Kafka Connect" - } + ] }, "com.amazonaws.kafkaconnect#ListConnectors": { "type": "operation", @@ -1687,7 +1779,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of all the connectors in this account and Region. The list is limited to connectors whose name starts with the specified prefix. The response also includes a description of each of the listed connectors.

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

Returns a list of all the connectors in this account and Region. The list is limited to\n connectors whose name starts with the specified prefix. The response also includes a\n description of each of the listed connectors.

", "smithy.api#http": { "method": "GET", "uri": "/v1/connectors", @@ -1696,8 +1788,8 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "connectors", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "connectors" }, "smithy.api#readonly": {} } @@ -1722,7 +1814,7 @@ "nextToken": { "target": "com.amazonaws.kafkaconnect#__string", "traits": { - "smithy.api#documentation": "

If the response of a ListConnectors operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.

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

If the response of a ListConnectors operation is truncated, it will include a NextToken.\n Send this NextToken in a subsequent request to continue listing from where the previous\n operation left off.

", "smithy.api#httpQuery": "nextToken" } } @@ -1740,7 +1832,7 @@ "nextToken": { "target": "com.amazonaws.kafkaconnect#__string", "traits": { - "smithy.api#documentation": "

If the response of a ListConnectors operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where it left off.

" + "smithy.api#documentation": "

If the response of a ListConnectors operation is truncated, it will include a NextToken.\n Send this NextToken in a subsequent request to continue listing from where it left\n off.

" } } } @@ -1786,8 +1878,8 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "customPlugins", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "customPlugins" }, "smithy.api#readonly": {} } @@ -1805,7 +1897,7 @@ "nextToken": { "target": "com.amazonaws.kafkaconnect#__string", "traits": { - "smithy.api#documentation": "

If the response of a ListCustomPlugins operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.

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

If the response of a ListCustomPlugins operation is truncated, it will include a\n NextToken. Send this NextToken in a subsequent request to continue listing from where the\n previous operation left off.

", "smithy.api#httpQuery": "nextToken" } } @@ -1823,7 +1915,7 @@ "nextToken": { "target": "com.amazonaws.kafkaconnect#__string", "traits": { - "smithy.api#documentation": "

If the response of a ListCustomPlugins operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.

" + "smithy.api#documentation": "

If the response of a ListCustomPlugins operation is truncated, it will include a\n NextToken. Send this NextToken in a subsequent request to continue listing from where the\n previous operation left off.

" } } } @@ -1869,8 +1961,8 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "workerConfigurations", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "workerConfigurations" }, "smithy.api#readonly": {} } @@ -1888,7 +1980,7 @@ "nextToken": { "target": "com.amazonaws.kafkaconnect#__string", "traits": { - "smithy.api#documentation": "

If the response of a ListWorkerConfigurations operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.

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

If the response of a ListWorkerConfigurations operation is truncated, it will include a\n NextToken. Send this NextToken in a subsequent request to continue listing from where the\n previous operation left off.

", "smithy.api#httpQuery": "nextToken" } } @@ -1900,7 +1992,7 @@ "nextToken": { "target": "com.amazonaws.kafkaconnect#__string", "traits": { - "smithy.api#documentation": "

If the response of a ListWorkerConfigurations operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.

" + "smithy.api#documentation": "

If the response of a ListWorkerConfigurations operation is truncated, it will include a\n NextToken. Send this NextToken in a subsequent request to continue listing from where the\n previous operation left off.

" } }, "workerConfigurations": { @@ -1917,7 +2009,7 @@ "workerLogDelivery": { "target": "com.amazonaws.kafkaconnect#WorkerLogDelivery", "traits": { - "smithy.api#documentation": "

The workers can send worker logs to different destination types. This configuration specifies the details of these destinations.

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

The workers can send worker logs to different destination types. This configuration\n specifies the details of these destinations.

", "smithy.api#required": {} } } @@ -1932,7 +2024,7 @@ "workerLogDelivery": { "target": "com.amazonaws.kafkaconnect#WorkerLogDeliveryDescription", "traits": { - "smithy.api#documentation": "

The workers can send worker logs to different destination types. This configuration specifies the details of these destinations.

" + "smithy.api#documentation": "

The workers can send worker logs to different destination types. This configuration\n specifies the details of these destinations.

" } } }, @@ -1957,7 +2049,7 @@ } }, "traits": { - "smithy.api#documentation": "

HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.

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

HTTP Status Code 404: Resource not found due to incorrect input. Correct your request\n and then retry it.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -1974,7 +2066,7 @@ } }, "traits": { - "smithy.api#documentation": "

A plugin is an AWS resource that contains the code that defines your connector logic.

" + "smithy.api#documentation": "

A plugin is an AWS resource that contains the code that defines your connector logic.\n

" } }, "com.amazonaws.kafkaconnect#PluginDescription": { @@ -1997,7 +2089,7 @@ "mcuCount": { "target": "com.amazonaws.kafkaconnect#__integerMin1Max8", "traits": { - "smithy.api#documentation": "

The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.

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

The number of microcontroller units (MCUs) allocated to each connector worker. The valid\n values are 1,2,4,8.

", "smithy.api#required": {} } }, @@ -2019,7 +2111,7 @@ "mcuCount": { "target": "com.amazonaws.kafkaconnect#__integer", "traits": { - "smithy.api#documentation": "

The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.

" + "smithy.api#documentation": "

The number of microcontroller units (MCUs) allocated to each connector worker. The valid\n values are 1,2,4,8.

" } }, "workerCount": { @@ -2039,7 +2131,7 @@ "mcuCount": { "target": "com.amazonaws.kafkaconnect#__integerMin1Max8", "traits": { - "smithy.api#documentation": "

The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.

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

The number of microcontroller units (MCUs) allocated to each connector worker. The valid\n values are 1,2,4,8.

", "smithy.api#required": {} } }, @@ -2168,7 +2260,7 @@ "cpuUtilizationPercentage": { "target": "com.amazonaws.kafkaconnect#__integerMin1Max100", "traits": { - "smithy.api#documentation": "

Specifies the CPU utilization percentage threshold at which you want connector scale in to be triggered.

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

Specifies the CPU utilization percentage threshold at which you want connector scale in\n to be triggered.

", "smithy.api#required": {} } } @@ -2183,7 +2275,7 @@ "cpuUtilizationPercentage": { "target": "com.amazonaws.kafkaconnect#__integer", "traits": { - "smithy.api#documentation": "

Specifies the CPU utilization percentage threshold at which you want connector scale in to be triggered.

" + "smithy.api#documentation": "

Specifies the CPU utilization percentage threshold at which you want connector scale in\n to be triggered.

" } } }, @@ -2197,7 +2289,7 @@ "cpuUtilizationPercentage": { "target": "com.amazonaws.kafkaconnect#__integerMin1Max100", "traits": { - "smithy.api#documentation": "

The target CPU utilization percentage threshold at which you want connector scale in to be triggered.

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

The target CPU utilization percentage threshold at which you want connector scale in to\n be triggered.

", "smithy.api#required": {} } } @@ -2212,7 +2304,7 @@ "cpuUtilizationPercentage": { "target": "com.amazonaws.kafkaconnect#__integerMin1Max100", "traits": { - "smithy.api#documentation": "

The CPU utilization percentage threshold at which you want connector scale out to be triggered.

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

The CPU utilization percentage threshold at which you want connector scale out to be\n triggered.

", "smithy.api#required": {} } } @@ -2227,7 +2319,7 @@ "cpuUtilizationPercentage": { "target": "com.amazonaws.kafkaconnect#__integer", "traits": { - "smithy.api#documentation": "

The CPU utilization percentage threshold at which you want connector scale out to be triggered.

" + "smithy.api#documentation": "

The CPU utilization percentage threshold at which you want connector scale out to be\n triggered.

" } } }, @@ -2241,7 +2333,7 @@ "cpuUtilizationPercentage": { "target": "com.amazonaws.kafkaconnect#__integerMin1Max100", "traits": { - "smithy.api#documentation": "

The target CPU utilization percentage threshold at which you want connector scale out to be triggered.

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

The target CPU utilization percentage threshold at which you want connector scale out to\n be triggered.

", "smithy.api#required": {} } } @@ -2258,11 +2350,31 @@ } }, "traits": { - "smithy.api#documentation": "

HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue.

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

HTTP Status Code 503: Service Unavailable. Retrying your request in some time might\n resolve the issue.

", "smithy.api#error": "server", "smithy.api#httpError": 503 } }, + "com.amazonaws.kafkaconnect#StateDescription": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.kafkaconnect#__string", + "traits": { + "smithy.api#documentation": "

A code that describes the state of a resource.

" + } + }, + "message": { + "target": "com.amazonaws.kafkaconnect#__string", + "traits": { + "smithy.api#documentation": "

A message that describes the state of a resource.

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

Details about the state of a resource.

" + } + }, "com.amazonaws.kafkaconnect#TooManyRequestsException": { "type": "structure", "members": { @@ -2284,7 +2396,7 @@ } }, "traits": { - "smithy.api#documentation": "

HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.

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

HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be\n validated.

", "smithy.api#error": "client", "smithy.api#httpError": 401 } @@ -2435,7 +2547,7 @@ } }, "traits": { - "smithy.api#documentation": "

The configuration of the workers, which are the processes that run the connector logic.

" + "smithy.api#documentation": "

The configuration of the workers, which are the processes that run the connector\n logic.

" } }, "com.amazonaws.kafkaconnect#WorkerConfigurationDescription": { @@ -2476,7 +2588,8 @@ "propertiesFileContent": { "target": "com.amazonaws.kafkaconnect#__string", "traits": { - "smithy.api#documentation": "

Base64 encoded contents of the connect-distributed.properties file.

" + "smithy.api#documentation": "

Base64 encoded contents of the connect-distributed.properties file.

", + "smithy.api#sensitive": {} } }, "revision": { @@ -2577,7 +2690,7 @@ } }, "traits": { - "smithy.api#documentation": "

Workers can send worker logs to different destination types. This configuration specifies the details of these destinations.

" + "smithy.api#documentation": "

Workers can send worker logs to different destination types. This configuration\n specifies the details of these destinations.

" } }, "com.amazonaws.kafkaconnect#WorkerLogDeliveryDescription": { @@ -2603,7 +2716,7 @@ } }, "traits": { - "smithy.api#documentation": "

Workers can send worker logs to different destination types. This configuration specifies the details of these destinations.

" + "smithy.api#documentation": "

Workers can send worker logs to different destination types. This configuration\n specifies the details of these destinations.

" } }, "com.amazonaws.kafkaconnect#__boolean": { diff --git a/aws/sdk/aws-models/kendra.json b/aws/sdk/aws-models/kendra.json index 75319ca73b..32c790ca6a 100644 --- a/aws/sdk/aws-models/kendra.json +++ b/aws/sdk/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
    \n
  • \n

    username - The user name or email address of a user with\n administrative privileges for the Confluence server.

    \n
    • \n
  • \n

    password - The password associated with the user logging\n in to the Confluence server.

    \n
    • \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
    \n
  • \n

    username—The user name or email address of a user with\n administrative privileges for the Confluence server.

    \n
    • \n
  • \n

    password—The password associated with the user logging\n in to the Confluence server.

    \n
    • \n
", "smithy.api#required": {} } }, @@ -1397,48 +1397,48 @@ "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.

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

Provides configuration information for data sources that connect\n to Confluence.

" + "smithy.api#documentation": "

Provides the configuration information to connect to Confluence \n as your data source.

" } }, "com.amazonaws.kendra#ConfluencePageConfiguration": { @@ -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": { @@ -1723,7 +1723,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides the information necessary to connect to a\n database.

" + "smithy.api#documentation": "

Provides the configuration information that's required to connect to a\n database.

" } }, "com.amazonaws.kendra#ContentSourceConfiguration": { @@ -1749,7 +1749,7 @@ } }, "traits": { - "smithy.api#documentation": "

Configuration information for your content sources, such as data sources, \n FAQs, and content indexed directly via BatchPutDocument.

" + "smithy.api#documentation": "

Provides the configuration information for your content sources, such as data sources, \n FAQs, and content indexed directly via BatchPutDocument.

" } }, "com.amazonaws.kendra#ContentType": { @@ -1779,6 +1779,44 @@ ] } }, + "com.amazonaws.kendra#Correction": { + "type": "structure", + "members": { + "BeginOffset": { + "target": "com.amazonaws.kendra#Integer", + "traits": { + "smithy.api#documentation": "

The zero-based location in the response string or text where \n the corrected word starts.

" + } + }, + "EndOffset": { + "target": "com.amazonaws.kendra#Integer", + "traits": { + "smithy.api#documentation": "

The zero-based location in the response string or text where \n the corrected word ends.

" + } + }, + "Term": { + "target": "com.amazonaws.kendra#String", + "traits": { + "smithy.api#documentation": "

The string or text of a misspelled word in a query.

" + } + }, + "CorrectedTerm": { + "target": "com.amazonaws.kendra#String", + "traits": { + "smithy.api#documentation": "

The string or text of a corrected misspelled word in a query.

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

A corrected misspelled word in a query.

" + } + }, + "com.amazonaws.kendra#CorrectionList": { + "type": "list", + "member": { + "target": "com.amazonaws.kendra#Correction" + } + }, "com.amazonaws.kendra#CrawlDepth": { "type": "integer", "traits": { @@ -1854,7 +1892,7 @@ "Configuration": { "target": "com.amazonaws.kendra#DataSourceConfiguration", "traits": { - "smithy.api#documentation": "

The connector configuration information that is required to access the\n repository.

\n

You can't specify the Configuration parameter when the\n Type parameter is set to CUSTOM. If you do,\n you receive a ValidationException exception.

\n

The Configuration parameter is required for all other\n data sources.

" + "smithy.api#documentation": "

Configuration information that is required to access the data source \n repository.

\n

You can't specify the Configuration parameter when the\n Type parameter is set to CUSTOM. If you do,\n you receive a ValidationException exception.

\n

The Configuration parameter is required for all other\n data sources.

" } }, "Description": { @@ -1975,7 +2013,7 @@ "Configuration": { "target": "com.amazonaws.kendra#ExperienceConfiguration", "traits": { - "smithy.api#documentation": "

Provides the configuration information for your Amazon Kendra experience. This includes\n ContentSourceConfiguration, which specifies the data source IDs \n and/or FAQ IDs, and UserIdentityConfiguration, which specifies the \n user or group information to grant access to your Amazon Kendra experience.

" + "smithy.api#documentation": "

Configuration information for your Amazon Kendra experience. This includes\n ContentSourceConfiguration, which specifies the data source IDs \n and/or FAQ IDs, and UserIdentityConfiguration, which specifies the \n user or group information to grant access to your Amazon Kendra experience.

" } }, "Description": { @@ -2463,49 +2501,49 @@ "S3Configuration": { "target": "com.amazonaws.kendra#S3DataSourceConfiguration", "traits": { - "smithy.api#documentation": "

Provides information to create a data source connector for a\n document repository in an Amazon S3 bucket.

" + "smithy.api#documentation": "

Provides the configuration information to connect to an Amazon S3 \n bucket as your data source.

" } }, "SharePointConfiguration": { "target": "com.amazonaws.kendra#SharePointConfiguration", "traits": { - "smithy.api#documentation": "

Provides information necessary to create a data source connector\n for a Microsoft SharePoint site.

" + "smithy.api#documentation": "

Provides the configuration information to connect to Microsoft SharePoint \n as your data source.

" } }, "DatabaseConfiguration": { "target": "com.amazonaws.kendra#DatabaseConfiguration", "traits": { - "smithy.api#documentation": "

Provides information necessary to create a data source connector\n for a database.

" + "smithy.api#documentation": "

Provides the configuration information to connect to a database as \n your data source.

" } }, "SalesforceConfiguration": { "target": "com.amazonaws.kendra#SalesforceConfiguration", "traits": { - "smithy.api#documentation": "

Provides configuration information for data sources that connect\n to a Salesforce site.

" + "smithy.api#documentation": "

Provides the configuration information to connect to \n Salesforce as your data source.

" } }, "OneDriveConfiguration": { "target": "com.amazonaws.kendra#OneDriveConfiguration", "traits": { - "smithy.api#documentation": "

Provides configuration for data sources that connect to Microsoft\n OneDrive.

" + "smithy.api#documentation": "

Provides the configuration information to connect to Microsoft\n OneDrive as your data source.

" } }, "ServiceNowConfiguration": { "target": "com.amazonaws.kendra#ServiceNowConfiguration", "traits": { - "smithy.api#documentation": "

Provides configuration for data sources that connect to ServiceNow\n instances.

" + "smithy.api#documentation": "

Provides the configuration information to connect to ServiceNow\n as your data source.

" } }, "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 configuration for data sources that connect to Google\n Drive.

" + "smithy.api#documentation": "

Provides the configuration information to connect to Google\n Drive as your data source.

" } }, "WebCrawlerConfiguration": { @@ -2522,10 +2560,16 @@ "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": { - "smithy.api#documentation": "

Configuration information for an Amazon Kendra data source.

" + "smithy.api#documentation": "

Provides the configuration information for an Amazon Kendra data source.

" } }, "com.amazonaws.kendra#DataSourceDateFieldFormat": { @@ -2567,7 +2611,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n Data source information for user context filtering.\n

" + "smithy.api#documentation": "

Data source information for user context filtering.

" } }, "com.amazonaws.kendra#DataSourceGroups": { @@ -2975,6 +3019,10 @@ { "value": "FSX", "name": "FSX" + }, + { + "value": "SLACK", + "name": "SLACK" } ] } @@ -2998,7 +3046,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides information for connecting to an Amazon VPC.

" + "smithy.api#documentation": "

Provides the configuration information to connect to an Amazon VPC.

" } }, "com.amazonaws.kendra#DatabaseConfiguration": { @@ -3014,7 +3062,7 @@ "ConnectionConfiguration": { "target": "com.amazonaws.kendra#ConnectionConfiguration", "traits": { - "smithy.api#documentation": "

The information necessary to connect to a database.

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

Configuration information that's required to connect to a database.

", "smithy.api#required": {} } }, @@ -3042,7 +3090,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides the information necessary to connect a database to an\n index.

" + "smithy.api#documentation": "

Provides the configuration information to connect to a \n index.

" } }, "com.amazonaws.kendra#DatabaseEngineType": { @@ -3523,7 +3571,7 @@ "Configuration": { "target": "com.amazonaws.kendra#DataSourceConfiguration", "traits": { - "smithy.api#documentation": "

Information that describes where the data source is located and how\n the data source is configured. The specific information in the description\n depends on the data source provider.

" + "smithy.api#documentation": "

Describes how the data source is configured. The specific information in the description\n depends on the data source provider.

" } }, "CreatedAt": { @@ -5070,7 +5118,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides the configuration information of users or groups in \n your Amazon Web Services SSO identity source to grant access your Amazon Kendra \n experience.

" + "smithy.api#documentation": "

Provides the configuration information for users or groups in \n your Amazon Web Services SSO identity source to grant access your Amazon Kendra \n experience.

" } }, "com.amazonaws.kendra#EntityDisplayData": { @@ -5152,7 +5200,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides the configuration information of users or groups in your \n Amazon Web Services SSO identity source for access to your Amazon Kendra experience. \n Specific permissions are defined for each user or group once they are \n granted access to your Amazon Kendra experience.

" + "smithy.api#documentation": "

Provides the configuration information for users or groups in your \n Amazon Web Services SSO identity source for access to your Amazon Kendra experience. \n Specific permissions are defined for each user or group once they are \n granted access to your Amazon Kendra experience.

" } }, "com.amazonaws.kendra#EntityPersonaConfigurationList": { @@ -5260,7 +5308,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies the configuration information for your Amazon Kendra experience. This includes \n the data source IDs and/or FAQ IDs, and user or group information to grant access \n to your Amazon Kendra experience.

" + "smithy.api#documentation": "

Provides the configuration information for your Amazon Kendra experience. This includes \n the data source IDs and/or FAQ IDs, and user or group information to grant access \n to your Amazon Kendra experience.

" } }, "com.amazonaws.kendra#ExperienceEndpoint": { @@ -5280,7 +5328,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides the configuration information of the endpoint for your Amazon Kendra\n experience.

" + "smithy.api#documentation": "

Provides the configuration information for the endpoint for your Amazon Kendra\n experience.

" } }, "com.amazonaws.kendra#ExperienceEndpoints": { @@ -5697,32 +5745,32 @@ "VpcConfiguration": { "target": "com.amazonaws.kendra#DataSourceVpcConfiguration", "traits": { - "smithy.api#documentation": "

Provides the 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": {} } }, "SecretArn": { "target": "com.amazonaws.kendra#SecretArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Secrets Manager secret that \n contains the key-value pairs required to connect to your Amazon FSx \n file system. Windows is currently the only supported type. The secret must \n contain a JSON structure with the following keys:

\n
    \n
  • \n

    username—The Active Directory user name, along with the \n Domain Name System (DNS) domain name. For example, \n user@corp.example.com. The Active Directory \n user account must have read and mounting access to the \n Amazon FSx file system for Windows.

    \n
    • \n
  • \n

    password—The password of the active directory user with \n read and mounting access Amazon FSx Windows file system.

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

The Amazon Resource Name (ARN) of an Secrets Manager secret that \n contains the key-value pairs required to connect to your Amazon FSx \n file system. Windows is currently the only supported type. The secret must \n contain a JSON structure with the following keys:

\n
    \n
  • \n

    username—The Active Directory user name, along with the \n Domain Name System (DNS) domain name. For example, \n user@corp.example.com. The Active Directory \n user account must have read and mounting access to the \n Amazon FSx file system for Windows.

    \n
    • \n
  • \n

    password—The password of the Active Directory user account with \n read and mounting access to the Amazon FSx Windows file system.

    \n
    • \n
" } }, "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": { "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", "traits": { - "smithy.api#documentation": "

A list of DataSourceToIndexFieldMapping objects that \n map Amazon FSx data source attributes or field names to Amazon Kendra \n index field names in Amazon Kendra. To create custom fields, use the \n UpdateIndex API before you map to Amazon FSx fields. \n For more information, see Mapping \n data source fields. The Amazon FSx data source field names \n must exist in your Amazon FSx custom metadata.

" + "smithy.api#documentation": "

A list of DataSourceToIndexFieldMapping objects that \n map Amazon FSx 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 FSx fields. \n For more information, see Mapping \n data source fields. The Amazon FSx data source field names \n must exist in your Amazon FSx custom metadata.

" } } }, @@ -5929,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": { @@ -5964,7 +6012,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides configuration information for data sources that connect\n to Google Drive.

" + "smithy.api#documentation": "

Provides the configuration information to connect to \n Google Drive as your data source.

" } }, "com.amazonaws.kendra#GroupAttributeField": { @@ -6280,7 +6328,7 @@ } }, "traits": { - "smithy.api#documentation": "

A summary of information about an index.

" + "smithy.api#documentation": "

A summary of information on the configuration of an index.

" } }, "com.amazonaws.kendra#IndexConfigurationSummaryList": { @@ -6541,7 +6589,7 @@ } }, "traits": { - "smithy.api#documentation": "

Configuration information for the JSON token type.

" + "smithy.api#documentation": "

Provides the configuration information for the JSON token type.

" } }, "com.amazonaws.kendra#JwtTokenTypeConfiguration": { @@ -6592,7 +6640,7 @@ } }, "traits": { - "smithy.api#documentation": "

Configuration information for the JWT token type.

" + "smithy.api#documentation": "

Provides the configuration information for the JWT token type.

" } }, "com.amazonaws.kendra#KeyLocation": { @@ -7255,7 +7303,7 @@ "IndexConfigurationSummaryItems": { "target": "com.amazonaws.kendra#IndexConfigurationSummaryList", "traits": { - "smithy.api#documentation": "

An array of summary information for one or more indexes.

" + "smithy.api#documentation": "

An array of summary information on the configuration of one or more indexes.

" } }, "NextToken": { @@ -7470,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": { @@ -7785,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": { @@ -7808,7 +7866,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides configuration information for data sources that connect\n to OneDrive.

" + "smithy.api#documentation": "

Provides the configuration information to connect\n to OneDrive as your data source.

" } }, "com.amazonaws.kendra#OneDriveUser": { @@ -8044,6 +8102,12 @@ ] } }, + "com.amazonaws.kendra#PrivateChannelFilter": { + "type": "list", + "member": { + "target": "com.amazonaws.kendra#String" + } + }, "com.amazonaws.kendra#ProxyConfiguration": { "type": "structure", "members": { @@ -8072,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": { @@ -8292,6 +8362,12 @@ "traits": { "smithy.api#documentation": "

Provides an identifier for a specific user. The\n VisitorId should be a unique identifier, such as a\n GUID. Don't use personally identifiable information, such as the user's\n email address, as the VisitorId.

" } + }, + "SpellCorrectionConfiguration": { + "target": "com.amazonaws.kendra#SpellCorrectionConfiguration", + "traits": { + "smithy.api#documentation": "

Enables suggested spell corrections for queries.

" + } } } }, @@ -8327,6 +8403,12 @@ "traits": { "smithy.api#documentation": "

A list of warning codes and their messages on problems with your query.

\n

Amazon Kendra currently only supports one type of warning, which is a warning \n on invalid syntax used in the query. For examples of invalid query syntax, \n see Searching \n with advanced query syntax.

" } + }, + "SpellCorrectedQueries": { + "target": "com.amazonaws.kendra#SpellCorrectedQueryList", + "traits": { + "smithy.api#documentation": "

A list of information related to suggested spell corrections for a query.

" + } } } }, @@ -8773,7 +8855,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides configuration information for a data source to index\n documents in an Amazon S3 bucket.

" + "smithy.api#documentation": "

Provides the configuration information to connect to \n an Amazon S3 bucket.

" } }, "com.amazonaws.kendra#S3ObjectKey": { @@ -8837,7 +8919,7 @@ } }, "traits": { - "smithy.api#documentation": "

Defines configuration for syncing a Salesforce chatter feed. The\n contents of the object comes from the Salesforce FeedItem\n table.

" + "smithy.api#documentation": "

The configuration information for syncing a Salesforce chatter feed. The\n contents of the object comes from the Salesforce FeedItem\n table.

" } }, "com.amazonaws.kendra#SalesforceChatterFeedIncludeFilterType": { @@ -8887,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": { @@ -8911,24 +8993,24 @@ "StandardObjectAttachmentConfiguration": { "target": "com.amazonaws.kendra#SalesforceStandardObjectAttachmentConfiguration", "traits": { - "smithy.api#documentation": "

Provides configuration information for processing attachments to\n Salesforce standard objects.

" + "smithy.api#documentation": "

Configuration information for processing attachments to\n Salesforce standard objects.

" } }, "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": { @@ -8957,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": { @@ -9000,18 +9082,18 @@ "StandardKnowledgeArticleTypeConfiguration": { "target": "com.amazonaws.kendra#SalesforceStandardKnowledgeArticleTypeConfiguration", "traits": { - "smithy.api#documentation": "

Provides configuration information for standard Salesforce\n knowledge articles.

" + "smithy.api#documentation": "

Configuration information for standard Salesforce\n knowledge articles.

" } }, "CustomKnowledgeArticleTypeConfigurations": { "target": "com.amazonaws.kendra#SalesforceCustomKnowledgeArticleTypeConfigurationList", "traits": { - "smithy.api#documentation": "

Provides configuration information for custom Salesforce knowledge\n articles.

" + "smithy.api#documentation": "

Configuration information for custom Salesforce knowledge\n articles.

" } } }, "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": "

Provides the configuration information for the knowledge article\n types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge\n articles and the standard fields of knowledge articles, or the\n custom fields of custom knowledge articles, but not both

" } }, "com.amazonaws.kendra#SalesforceKnowledgeArticleState": { @@ -9064,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": "

Provides 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": { @@ -9089,7 +9171,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides 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": { @@ -9118,12 +9200,12 @@ "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.

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

Specifies configuration information for indexing a single standard\n object.

" + "smithy.api#documentation": "

Provides the configuration information for indexing a single standard\n object.

" } }, "com.amazonaws.kendra#SalesforceStandardObjectConfigurationList": { @@ -9340,7 +9422,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides the configuration information of the seed or starting point URLs to crawl.

\n

\n When selecting websites to index, you must adhere to \n the Amazon Acceptable Use Policy \n and all other Amazon terms. Remember that you must only use Amazon Kendra Web \n Crawler to index your own webpages, or webpages that you have authorization \n to index.\n

" + "smithy.api#documentation": "

Provides the configuration information for the seed or starting point URLs to crawl.

\n

\n When selecting websites to index, you must adhere to \n the Amazon Acceptable Use Policy \n and all other Amazon terms. Remember that you must only use Amazon Kendra Web \n Crawler to index your own webpages, or webpages that you have authorization \n to index.\n

" } }, "com.amazonaws.kendra#SeedUrlList": { @@ -9405,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": {} } }, @@ -9426,24 +9508,24 @@ "KnowledgeArticleConfiguration": { "target": "com.amazonaws.kendra#ServiceNowKnowledgeArticleConfiguration", "traits": { - "smithy.api#documentation": "

Provides configuration information for crawling knowledge articles\n in the ServiceNow site.

" + "smithy.api#documentation": "

Configuration information for crawling knowledge articles\n in the ServiceNow site.

" } }, "ServiceCatalogConfiguration": { "target": "com.amazonaws.kendra#ServiceNowServiceCatalogConfiguration", "traits": { - "smithy.api#documentation": "

Provides configuration information for crawling service catalogs\n in the ServiceNow site.

" + "smithy.api#documentation": "

Configuration information for crawling service catalogs\n in the ServiceNow site.

" } }, "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.

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

Provides configuration information required to connect to a\n ServiceNow data source.

" + "smithy.api#documentation": "

Provides the configuration information to connect to \n ServiceNow as your data source.

" } }, "com.amazonaws.kendra#ServiceNowHostUrl": { @@ -9468,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": { @@ -9493,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": { @@ -9504,7 +9586,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides configuration information for crawling knowledge articles\n in the ServiceNow site.

" + "smithy.api#documentation": "

Provides the configuration information for crawling knowledge articles\n in the ServiceNow site.

" } }, "com.amazonaws.kendra#ServiceNowKnowledgeArticleFilterQuery": { @@ -9529,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": { @@ -9554,12 +9636,12 @@ "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.

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

Provides configuration information for crawling service catalog\n items in the ServiceNow site

" + "smithy.api#documentation": "

Provides the configuration information for crawling service catalog\n items in the ServiceNow site

" } }, "com.amazonaws.kendra#ServiceQuotaExceededException": { @@ -9608,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": { @@ -9629,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": { @@ -9649,7 +9731,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides configuration information for connecting to a Microsoft\n SharePoint data source.

" + "smithy.api#documentation": "

Provides the configuration information to connect to Microsoft\n SharePoint as your data source.

" } }, "com.amazonaws.kendra#SharePointUrlList": { @@ -9693,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": { @@ -9715,7 +9807,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides the configuration information of the sitemap URLs to crawl.

\n

\n When selecting websites to index, you must adhere to \n the Amazon Acceptable Use Policy \n and all other Amazon terms. Remember that you must only use Amazon Kendra Web \n Crawler to index your own webpages, or webpages that you have authorization \n to index.\n

" + "smithy.api#documentation": "

Provides the configuration information for the sitemap URLs to crawl.

\n

\n When selecting websites to index, you must adhere to \n the Amazon Acceptable Use Policy \n and all other Amazon terms. Remember that you must only use Amazon Kendra Web \n Crawler to index your own webpages, or webpages that you have authorization \n to index.\n

" } }, "com.amazonaws.kendra#SiteMapsList": { @@ -9730,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": { @@ -9785,6 +10008,47 @@ "smithy.api#documentation": "

Specifies the document attribute to use to sort the response to a\n Amazon Kendra query. You can specify a single attribute for sorting. The\n attribute must have the Sortable flag set to\n true, otherwise Amazon Kendra returns an exception.

\n

You can sort attributes of the following types.

\n
    \n
  • \n

    Date value

    \n
    • \n
  • \n

    Long value

    \n
    • \n
  • \n

    String value

    \n
    • \n
\n

You can't sort attributes of the following type.

\n
    \n
  • \n

    String list value

    \n
    • \n
" } }, + "com.amazonaws.kendra#SpellCorrectedQuery": { + "type": "structure", + "members": { + "SuggestedQueryText": { + "target": "com.amazonaws.kendra#SuggestedQueryText", + "traits": { + "smithy.api#documentation": "

The query with the suggested spell corrections.

" + } + }, + "Corrections": { + "target": "com.amazonaws.kendra#CorrectionList", + "traits": { + "smithy.api#documentation": "

The corrected misspelled word or words in a query.

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

A query with suggested spell corrections.

" + } + }, + "com.amazonaws.kendra#SpellCorrectedQueryList": { + "type": "list", + "member": { + "target": "com.amazonaws.kendra#SpellCorrectedQuery" + } + }, + "com.amazonaws.kendra#SpellCorrectionConfiguration": { + "type": "structure", + "members": { + "IncludeQuerySpellCheckSuggestions": { + "target": "com.amazonaws.kendra#Boolean", + "traits": { + "smithy.api#documentation": "

\n TRUE to suggest spell corrections for queries.

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

Provides the configuration information for suggested query spell corrections.

\n

Suggested spell corrections are based on words that appear in your indexed documents \n and how closely a corrected word matches a misspelled word.

\n

This feature is designed with certain defaults or limits. For information on the \n current limits and how to request more support for some limits, see the \n Spell \n Checker documentation.

" + } + }, "com.amazonaws.kendra#SqlConfiguration": { "type": "structure", "members": { @@ -9796,7 +10060,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides information that configures Amazon Kendra to use a SQL\n database.

" + "smithy.api#documentation": "

Provides the configuration information to use a SQL\n database.

" } }, "com.amazonaws.kendra#StartDataSourceSyncJob": { @@ -10041,6 +10305,15 @@ } } }, + "com.amazonaws.kendra#SuggestedQueryText": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, "com.amazonaws.kendra#Suggestion": { "type": "structure", "members": { @@ -10259,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": { @@ -10562,7 +10845,7 @@ "Configuration": { "target": "com.amazonaws.kendra#DataSourceConfiguration", "traits": { - "smithy.api#documentation": "

Configuration information for an Amazon Kendra data source.

" + "smithy.api#documentation": "

Configuration information for an Amazon Kendra data source you want to update.

" } }, "Description": { @@ -10658,7 +10941,7 @@ "Configuration": { "target": "com.amazonaws.kendra#ExperienceConfiguration", "traits": { - "smithy.api#documentation": "

Provides the user configuration information. This includes the Amazon Web Services SSO\n field name that contains the identifiers of your users, such as their emails.

" + "smithy.api#documentation": "

Configuration information for your Amazon Kendra you want to update.

" } }, "Description": { @@ -10732,7 +11015,7 @@ "DocumentMetadataConfigurationUpdates": { "target": "com.amazonaws.kendra#DocumentMetadataConfigurationList", "traits": { - "smithy.api#documentation": "

The document metadata to update.

" + "smithy.api#documentation": "

The document metadata you want to update.

" } }, "CapacityUnits": { @@ -10989,13 +11272,13 @@ "SeedUrlConfiguration": { "target": "com.amazonaws.kendra#SeedUrlConfiguration", "traits": { - "smithy.api#documentation": "

Provides the configuration of the seed or starting point URLs of the websites \n you want to crawl.

\n

You can choose to crawl only the website host names, or the website host names \n with subdomains, or the website host names with subdomains and other domains \n that the webpages link to.

\n

You can list up to 100 seed URLs.

" + "smithy.api#documentation": "

Configuration of the seed or starting point URLs of the websites \n you want to crawl.

\n

You can choose to crawl only the website host names, or the website host names \n with subdomains, or the website host names with subdomains and other domains \n that the webpages link to.

\n

You can list up to 100 seed URLs.

" } }, "SiteMapsConfiguration": { "target": "com.amazonaws.kendra#SiteMapsConfiguration", "traits": { - "smithy.api#documentation": "

Provides the configuration of the sitemap URLs of the websites you want to crawl.

\n

Only URLs belonging to the same website host names are crawled. You can list up to \n three sitemap URLs.

" + "smithy.api#documentation": "

Configuration of the sitemap URLs of the websites you want to crawl.

\n

Only URLs belonging to the same website host names are crawled. You can list up to \n three sitemap URLs.

" } } }, @@ -11111,7 +11394,7 @@ } }, "traits": { - "smithy.api#documentation": "

Configuration information for the identifiers of your users.

" + "smithy.api#documentation": "

Provides the configuration information for the identifiers of your users.

" } }, "com.amazonaws.kendra#UserNameAttributeField": { @@ -11141,7 +11424,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides configuration information for a token configuration.

" + "smithy.api#documentation": "

Provides the configuration information for a token.

" } }, "com.amazonaws.kendra#UserTokenConfigurationList": { @@ -11297,25 +11580,25 @@ "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": { "target": "com.amazonaws.kendra#ProxyConfiguration", "traits": { - "smithy.api#documentation": "

Provides configuration information required to connect to your internal \n websites via a web proxy.

\n

You must provide the website host name and port number. For example, the \n host name of https://a.example.com/page1.html is \"a.example.com\" and the \n port is 443, the standard port for HTTPS.

\n

Web proxy credentials are optional and you can use them to connect to a \n web proxy server that requires basic authentication. To store web proxy \n credentials, you use a secret in Secrets Manager.

" + "smithy.api#documentation": "

Configuration information required to connect to your internal \n websites via a web proxy.

\n

You must provide the website host name and port number. For example, the \n host name of https://a.example.com/page1.html is \"a.example.com\" and the \n port is 443, the standard port for HTTPS.

\n

Web proxy credentials are optional and you can use them to connect to a \n web proxy server that requires basic authentication. To store web proxy \n credentials, you use a secret in Secrets Manager.

" } }, "AuthenticationConfiguration": { "target": "com.amazonaws.kendra#AuthenticationConfiguration", "traits": { - "smithy.api#documentation": "

Provides configuration information required to connect to websites using \n authentication.

\n

You can connect to websites using basic authentication of user name and password.

\n

You must provide the website host name and port number. For example, the host name \n of https://a.example.com/page1.html is \"a.example.com\" and the port is 443, the \n standard port for HTTPS. You use a secret in Secrets Manager to store \n your authentication credentials.

" + "smithy.api#documentation": "

Configuration information required to connect to websites using \n authentication.

\n

You can connect to websites using basic authentication of user name and password.

\n

You must provide the website host name and port number. For example, the host name \n of https://a.example.com/page1.html is \"a.example.com\" and the port is 443, the \n standard port for HTTPS. You use a secret in Secrets Manager to store \n your authentication credentials.

" } } }, @@ -11361,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/aws/sdk/aws-models/keyspaces.json b/aws/sdk/aws-models/keyspaces.json new file mode 100644 index 0000000000..60b2dc8243 --- /dev/null +++ b/aws/sdk/aws-models/keyspaces.json @@ -0,0 +1,1762 @@ +{ + "smithy": "1.0", + "shapes": { + "com.amazonaws.keyspaces#ARN": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 1000 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):cassandra:.+" + } + }, + "com.amazonaws.keyspaces#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AccessDeniedException", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

You do not have sufficient access to perform this action.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.keyspaces#CapacitySpecification": { + "type": "structure", + "members": { + "throughputMode": { + "target": "com.amazonaws.keyspaces#ThroughputMode", + "traits": { + "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": {} + } + }, + "readCapacityUnits": { + "target": "com.amazonaws.keyspaces#CapacityUnits", + "traits": { + "smithy.api#documentation": "

The throughput capacity specified for read operations defined in read capacity units \n (RCUs).

" + } + }, + "writeCapacityUnits": { + "target": "com.amazonaws.keyspaces#CapacityUnits", + "traits": { + "smithy.api#documentation": "

The throughput capacity specified for write operations defined in write capacity units \n (WCUs).

" + } + } + }, + "traits": { + "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": { + "type": "structure", + "members": { + "throughputMode": { + "target": "com.amazonaws.keyspaces#ThroughputMode", + "traits": { + "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": {} + } + }, + "readCapacityUnits": { + "target": "com.amazonaws.keyspaces#CapacityUnits", + "traits": { + "smithy.api#documentation": "

The throughput capacity specified for read operations defined in read capacity units \n (RCUs).

" + } + }, + "writeCapacityUnits": { + "target": "com.amazonaws.keyspaces#CapacityUnits", + "traits": { + "smithy.api#documentation": "

The throughput capacity specified for write operations defined in write capacity units \n (WCUs).

" + } + }, + "lastUpdateToPayPerRequestTimestamp": { + "target": "com.amazonaws.keyspaces#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of the last operation that changed the provisioned throughput capacity of a table.

" + } + } + }, + "traits": { + "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": { + "type": "long", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.keyspaces#ClusteringKey": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.keyspaces#GenericString", + "traits": { + "smithy.api#documentation": "

The name(s) of the clustering column(s).

", + "smithy.api#required": {} + } + }, + "orderBy": { + "target": "com.amazonaws.keyspaces#SortOrder", + "traits": { + "smithy.api#documentation": "

Sets the ascendant (ASC) or descendant (DESC) order modifier.

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

The optional clustering column portion of your primary key determines how the data is clustered and sorted within each partition.

" + } + }, + "com.amazonaws.keyspaces#ClusteringKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.keyspaces#ClusteringKey" + } + }, + "com.amazonaws.keyspaces#ColumnDefinition": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.keyspaces#GenericString", + "traits": { + "smithy.api#documentation": "

The name of the column.

", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.keyspaces#GenericString", + "traits": { + "smithy.api#documentation": "

The data type of the column. For a list of available data types, see Data types in the Amazon Keyspaces Developer\n Guide.

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

The names and data types of regular columns.

" + } + }, + "com.amazonaws.keyspaces#ColumnDefinitionList": { + "type": "list", + "member": { + "target": "com.amazonaws.keyspaces#ColumnDefinition" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.keyspaces#Comment": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

An optional description of the table.

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

An optional comment that describes the table.

" + } + }, + "com.amazonaws.keyspaces#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ConflictException", + "httpResponseCode": 409 + }, + "smithy.api#documentation": "

Amazon Keyspaces could not complete the requested action. This error may occur if you try to \n perform an action and the same or a different action is already\n in progress, or if you try to create a resource that already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.keyspaces#CreateKeyspace": { + "type": "operation", + "input": { + "target": "com.amazonaws.keyspaces#CreateKeyspaceRequest" + }, + "output": { + "target": "com.amazonaws.keyspaces#CreateKeyspaceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.keyspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.keyspaces#ConflictException" + }, + { + "target": "com.amazonaws.keyspaces#InternalServerException" + }, + { + "target": "com.amazonaws.keyspaces#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.keyspaces#ValidationException" + } + ], + "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.

" + } + }, + "com.amazonaws.keyspaces#CreateKeyspaceRequest": { + "type": "structure", + "members": { + "keyspaceName": { + "target": "com.amazonaws.keyspaces#KeyspaceName", + "traits": { + "smithy.api#documentation": "

The name of the keyspace to be created.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.keyspaces#TagList", + "traits": { + "smithy.api#documentation": "

A list of key-value pair tags to be attached to the keyspace.

\n

For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer\n Guide.

" + } + } + } + }, + "com.amazonaws.keyspaces#CreateKeyspaceResponse": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.keyspaces#ARN", + "traits": { + "smithy.api#documentation": "

The unique identifier of the keyspace in the format of an Amazon Resource Name (ARN).

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.keyspaces#CreateTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.keyspaces#CreateTableRequest" + }, + "output": { + "target": "com.amazonaws.keyspaces#CreateTableResponse" + }, + "errors": [ + { + "target": "com.amazonaws.keyspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.keyspaces#ConflictException" + }, + { + "target": "com.amazonaws.keyspaces#InternalServerException" + }, + { + "target": "com.amazonaws.keyspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.keyspaces#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.keyspaces#ValidationException" + } + ], + "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.

" + } + }, + "com.amazonaws.keyspaces#CreateTableRequest": { + "type": "structure", + "members": { + "keyspaceName": { + "target": "com.amazonaws.keyspaces#KeyspaceName", + "traits": { + "smithy.api#documentation": "

The name of the keyspace that the table is going to be created in.

", + "smithy.api#required": {} + } + }, + "tableName": { + "target": "com.amazonaws.keyspaces#TableName", + "traits": { + "smithy.api#documentation": "

The name of the table.

", + "smithy.api#required": {} + } + }, + "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

• 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": {} + } + }, + "comment": { + "target": "com.amazonaws.keyspaces#Comment", + "traits": { + "smithy.api#documentation": "

This parameter allows to enter a description of the table.

" + } + }, + "capacitySpecification": { + "target": "com.amazonaws.keyspaces#CapacitySpecification", + "traits": { + "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. \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": "

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": "

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": { + "target": "com.amazonaws.keyspaces#DefaultTimeToLive", + "traits": { + "smithy.api#documentation": "

The default Time to Live setting in seconds for the\n table.

\n

For more information, see Setting the default TTL value for a table in the Amazon Keyspaces Developer\n Guide.

" + } + }, + "tags": { + "target": "com.amazonaws.keyspaces#TagList", + "traits": { + "smithy.api#documentation": "

A list of key-value pair tags to be\n attached to the resource.

\n

For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer\n Guide.

" + } + } + } + }, + "com.amazonaws.keyspaces#CreateTableResponse": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.keyspaces#ARN", + "traits": { + "smithy.api#documentation": "

The unique identifier of the table in the format of an Amazon Resource Name (ARN).

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.keyspaces#DefaultTimeToLive": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 630720000 + } + } + }, + "com.amazonaws.keyspaces#DeleteKeyspace": { + "type": "operation", + "input": { + "target": "com.amazonaws.keyspaces#DeleteKeyspaceRequest" + }, + "output": { + "target": "com.amazonaws.keyspaces#DeleteKeyspaceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.keyspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.keyspaces#ConflictException" + }, + { + "target": "com.amazonaws.keyspaces#InternalServerException" + }, + { + "target": "com.amazonaws.keyspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.keyspaces#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.keyspaces#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

The DeleteKeyspace operation deletes a keyspace and all of its tables.

" + } + }, + "com.amazonaws.keyspaces#DeleteKeyspaceRequest": { + "type": "structure", + "members": { + "keyspaceName": { + "target": "com.amazonaws.keyspaces#KeyspaceName", + "traits": { + "smithy.api#documentation": "

The name of the keyspace to be deleted.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.keyspaces#DeleteKeyspaceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.keyspaces#DeleteTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.keyspaces#DeleteTableRequest" + }, + "output": { + "target": "com.amazonaws.keyspaces#DeleteTableResponse" + }, + "errors": [ + { + "target": "com.amazonaws.keyspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.keyspaces#ConflictException" + }, + { + "target": "com.amazonaws.keyspaces#InternalServerException" + }, + { + "target": "com.amazonaws.keyspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.keyspaces#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.keyspaces#ValidationException" + } + ], + "traits": { + "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": { + "type": "structure", + "members": { + "keyspaceName": { + "target": "com.amazonaws.keyspaces#KeyspaceName", + "traits": { + "smithy.api#documentation": "

The name of the keyspace of the to be deleted table.

", + "smithy.api#required": {} + } + }, + "tableName": { + "target": "com.amazonaws.keyspaces#TableName", + "traits": { + "smithy.api#documentation": "

The name of the table to be deleted.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.keyspaces#DeleteTableResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.keyspaces#EncryptionSpecification": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.keyspaces#EncryptionType", + "traits": { + "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.

" + } + } + }, + "traits": { + "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": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CUSTOMER_MANAGED_KMS_KEY", + "name": "CUSTOMER_MANAGED_KMS_KEY" + }, + { + "value": "AWS_OWNED_KMS_KEY", + "name": "AWS_OWNED_KMS_KEY" + } + ] + } + }, + "com.amazonaws.keyspaces#GenericString": { + "type": "string" + }, + "com.amazonaws.keyspaces#GetKeyspace": { + "type": "operation", + "input": { + "target": "com.amazonaws.keyspaces#GetKeyspaceRequest" + }, + "output": { + "target": "com.amazonaws.keyspaces#GetKeyspaceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.keyspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.keyspaces#InternalServerException" + }, + { + "target": "com.amazonaws.keyspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.keyspaces#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.keyspaces#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the name and the Amazon Resource Name (ARN) of the specified table.

" + } + }, + "com.amazonaws.keyspaces#GetKeyspaceRequest": { + "type": "structure", + "members": { + "keyspaceName": { + "target": "com.amazonaws.keyspaces#KeyspaceName", + "traits": { + "smithy.api#documentation": "

The name of the keyspace.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.keyspaces#GetKeyspaceResponse": { + "type": "structure", + "members": { + "keyspaceName": { + "target": "com.amazonaws.keyspaces#KeyspaceName", + "traits": { + "smithy.api#documentation": "

The name of the keyspace.

", + "smithy.api#required": {} + } + }, + "resourceArn": { + "target": "com.amazonaws.keyspaces#ARN", + "traits": { + "smithy.api#documentation": "

The ARN of the keyspace.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.keyspaces#GetTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.keyspaces#GetTableRequest" + }, + "output": { + "target": "com.amazonaws.keyspaces#GetTableResponse" + }, + "errors": [ + { + "target": "com.amazonaws.keyspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.keyspaces#InternalServerException" + }, + { + "target": "com.amazonaws.keyspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.keyspaces#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.keyspaces#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about the table, including the table's name and current status, the keyspace name, \n configuration settings, and metadata.

\n

To read table metadata using GetTable, Select action \n permissions for the table and system tables are required to complete the operation.

" + } + }, + "com.amazonaws.keyspaces#GetTableRequest": { + "type": "structure", + "members": { + "keyspaceName": { + "target": "com.amazonaws.keyspaces#KeyspaceName", + "traits": { + "smithy.api#documentation": "

The name of the keyspace that the table is stored in.

", + "smithy.api#required": {} + } + }, + "tableName": { + "target": "com.amazonaws.keyspaces#TableName", + "traits": { + "smithy.api#documentation": "

The name of the table.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.keyspaces#GetTableResponse": { + "type": "structure", + "members": { + "keyspaceName": { + "target": "com.amazonaws.keyspaces#KeyspaceName", + "traits": { + "smithy.api#documentation": "

The name of the keyspace that the specified table is stored in.

", + "smithy.api#required": {} + } + }, + "tableName": { + "target": "com.amazonaws.keyspaces#TableName", + "traits": { + "smithy.api#documentation": "

The name of the specified table.

", + "smithy.api#required": {} + } + }, + "resourceArn": { + "target": "com.amazonaws.keyspaces#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the specified table.

", + "smithy.api#required": {} + } + }, + "creationTimestamp": { + "target": "com.amazonaws.keyspaces#Timestamp", + "traits": { + "smithy.api#documentation": "

The creation timestamp of the specified table.

" + } + }, + "status": { + "target": "com.amazonaws.keyspaces#TableStatus", + "traits": { + "smithy.api#documentation": "

The current status of the specified table.

" + } + }, + "schemaDefinition": { + "target": "com.amazonaws.keyspaces#SchemaDefinition", + "traits": { + "smithy.api#documentation": "

The schema definition of the specified table.

" + } + }, + "capacitySpecification": { + "target": "com.amazonaws.keyspaces#CapacitySpecificationSummary", + "traits": { + "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": { + "target": "com.amazonaws.keyspaces#EncryptionSpecification", + "traits": { + "smithy.api#documentation": "

The encryption settings of the specified table.

" + } + }, + "pointInTimeRecovery": { + "target": "com.amazonaws.keyspaces#PointInTimeRecoverySummary", + "traits": { + "smithy.api#documentation": "

The point-in-time recovery status of the specified table.

" + } + }, + "ttl": { + "target": "com.amazonaws.keyspaces#TimeToLive", + "traits": { + "smithy.api#documentation": "

The custom Time to Live settings of the specified table.

" + } + }, + "defaultTimeToLive": { + "target": "com.amazonaws.keyspaces#DefaultTimeToLive", + "traits": { + "smithy.api#documentation": "

The default Time to Live settings of the specified table.

" + } + }, + "comment": { + "target": "com.amazonaws.keyspaces#Comment", + "traits": { + "smithy.api#documentation": "

The the description of the specified table.

" + } + } + } + }, + "com.amazonaws.keyspaces#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InternalServerException", + "httpResponseCode": 500 + }, + "smithy.api#documentation": "

Amazon Keyspaces was unable to fully process this request because of an internal server error.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.keyspaces#KeyspaceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 48 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9_]{1,47}$" + } + }, + "com.amazonaws.keyspaces#KeyspaceSummary": { + "type": "structure", + "members": { + "keyspaceName": { + "target": "com.amazonaws.keyspaces#KeyspaceName", + "traits": { + "smithy.api#documentation": "

The name of the keyspace.

", + "smithy.api#required": {} + } + }, + "resourceArn": { + "target": "com.amazonaws.keyspaces#ARN", + "traits": { + "smithy.api#documentation": "

The unique identifier of the keyspace in the format of an Amazon Resource Name (ARN).

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

Represents the properties of a keyspace.

" + } + }, + "com.amazonaws.keyspaces#KeyspaceSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.keyspaces#KeyspaceSummary" + } + }, + "com.amazonaws.keyspaces#KeyspacesService": { + "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Keyspaces", + "cloudFormationName": "Cassandra", + "arnNamespace": "cassandra", + "cloudTrailEventSource": "cassandra.amazonaws.com", + "endpointPrefix": "cassandra" + }, + "aws.auth#sigv4": { + "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

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", + "operations": [ + { + "target": "com.amazonaws.keyspaces#CreateKeyspace" + }, + { + "target": "com.amazonaws.keyspaces#CreateTable" + }, + { + "target": "com.amazonaws.keyspaces#DeleteKeyspace" + }, + { + "target": "com.amazonaws.keyspaces#DeleteTable" + }, + { + "target": "com.amazonaws.keyspaces#GetKeyspace" + }, + { + "target": "com.amazonaws.keyspaces#GetTable" + }, + { + "target": "com.amazonaws.keyspaces#ListKeyspaces" + }, + { + "target": "com.amazonaws.keyspaces#ListTables" + }, + { + "target": "com.amazonaws.keyspaces#ListTagsForResource" + }, + { + "target": "com.amazonaws.keyspaces#RestoreTable" + }, + { + "target": "com.amazonaws.keyspaces#TagResource" + }, + { + "target": "com.amazonaws.keyspaces#UntagResource" + }, + { + "target": "com.amazonaws.keyspaces#UpdateTable" + } + ] + }, + "com.amazonaws.keyspaces#ListKeyspaces": { + "type": "operation", + "input": { + "target": "com.amazonaws.keyspaces#ListKeyspacesRequest" + }, + "output": { + "target": "com.amazonaws.keyspaces#ListKeyspacesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.keyspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.keyspaces#InternalServerException" + }, + { + "target": "com.amazonaws.keyspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.keyspaces#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.keyspaces#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of keyspaces.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "keyspaces" + } + } + }, + "com.amazonaws.keyspaces#ListKeyspacesRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.keyspaces#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.

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

The total number of keyspaces to return in the output. If the total number of keyspaces available \n is more than the value specified, a NextToken is provided in the output. To resume pagination, \n provide the NextToken value as an argument of a subsequent API invocation.

" + } + } + } + }, + "com.amazonaws.keyspaces#ListKeyspacesResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.keyspaces#NextToken", + "traits": { + "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

" + } + }, + "keyspaces": { + "target": "com.amazonaws.keyspaces#KeyspaceSummaryList", + "traits": { + "smithy.api#documentation": "

A list of keyspaces.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.keyspaces#ListTables": { + "type": "operation", + "input": { + "target": "com.amazonaws.keyspaces#ListTablesRequest" + }, + "output": { + "target": "com.amazonaws.keyspaces#ListTablesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.keyspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.keyspaces#InternalServerException" + }, + { + "target": "com.amazonaws.keyspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.keyspaces#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.keyspaces#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of tables for a specified keyspace.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "tables" + } + } + }, + "com.amazonaws.keyspaces#ListTablesRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.keyspaces#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token. To resume pagination, provide the NextToken value as an argument of a subsequent API invocation.

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

The total number of tables to return in the output. If the total number of tables available \n is more than the value specified, a NextToken is provided in the output. To resume pagination, \n provide the NextToken value as an argument of a subsequent API invocation.

" + } + }, + "keyspaceName": { + "target": "com.amazonaws.keyspaces#KeyspaceName", + "traits": { + "smithy.api#documentation": "

The name of the keyspace.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.keyspaces#ListTablesResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.keyspaces#NextToken", + "traits": { + "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

" + } + }, + "tables": { + "target": "com.amazonaws.keyspaces#TableSummaryList", + "traits": { + "smithy.api#documentation": "

A list of tables.

" + } + } + } + }, + "com.amazonaws.keyspaces#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.keyspaces#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.keyspaces#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.keyspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.keyspaces#InternalServerException" + }, + { + "target": "com.amazonaws.keyspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.keyspaces#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.keyspaces#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of all tags associated with the specified Amazon Keyspaces resource.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "tags" + } + } + }, + "com.amazonaws.keyspaces#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.keyspaces#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Keyspaces resource.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.keyspaces#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.

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

The total number of tags to return in the output. If the total number of tags available \n is more than the value specified, a NextToken is provided in the output. To resume pagination, \n provide the NextToken value as an argument of a subsequent API invocation.

" + } + } + } + }, + "com.amazonaws.keyspaces#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.keyspaces#NextToken", + "traits": { + "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

" + } + }, + "tags": { + "target": "com.amazonaws.keyspaces#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags.

" + } + } + } + }, + "com.amazonaws.keyspaces#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.keyspaces#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.keyspaces#PartitionKey": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.keyspaces#GenericString", + "traits": { + "smithy.api#documentation": "

The name(s) of the partition key column(s).

", + "smithy.api#required": {} + } + } + }, + "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.

" + } + }, + "com.amazonaws.keyspaces#PartitionKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.keyspaces#PartitionKey" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.keyspaces#PointInTimeRecovery": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.keyspaces#PointInTimeRecoveryStatus", + "traits": { + "smithy.api#documentation": "

The options are:

\n

• ENABLED\n

\n

• DISABLED\n

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

Point-in-time recovery (PITR) helps protect your Amazon Keyspaces tables from accidental write or delete operations by providing you continuous backups of your table data.

\n

For more information, see Point-in-time recovery in the Amazon Keyspaces Developer\n Guide.

" + } + }, + "com.amazonaws.keyspaces#PointInTimeRecoveryStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ENABLED", + "name": "ENABLED" + }, + { + "value": "DISABLED", + "name": "DISABLED" + } + ] + } + }, + "com.amazonaws.keyspaces#PointInTimeRecoverySummary": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.keyspaces#PointInTimeRecoveryStatus", + "traits": { + "smithy.api#documentation": "

Shows if point-in-time recovery is enabled or disabled for the specified table.

", + "smithy.api#required": {} + } + }, + "earliestRestorableTimestamp": { + "target": "com.amazonaws.keyspaces#Timestamp", + "traits": { + "smithy.api#documentation": "

Specifies the earliest possible restore point of the table in ISO 8601 format.

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

The point-in-time recovery status of the specified table.

" + } + }, + "com.amazonaws.keyspaces#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + }, + "resourceArn": { + "target": "com.amazonaws.keyspaces#ARN", + "traits": { + "smithy.api#documentation": "

The unique identifier in the format of Amazon Resource Name (ARN), for the resource not found.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ResourceNotFoundException", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The operation tried to access a keyspace or table that doesn't exist. The resource might not be specified correctly, or its status might not be ACTIVE.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.keyspaces#RestoreTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.keyspaces#RestoreTableRequest" + }, + "output": { + "target": "com.amazonaws.keyspaces#RestoreTableResponse" + }, + "errors": [ + { + "target": "com.amazonaws.keyspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.keyspaces#ConflictException" + }, + { + "target": "com.amazonaws.keyspaces#InternalServerException" + }, + { + "target": "com.amazonaws.keyspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.keyspaces#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.keyspaces#ValidationException" + } + ], + "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

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": { + "type": "structure", + "members": { + "sourceKeyspaceName": { + "target": "com.amazonaws.keyspaces#KeyspaceName", + "traits": { + "smithy.api#documentation": "

The keyspace name of the source table.

", + "smithy.api#required": {} + } + }, + "sourceTableName": { + "target": "com.amazonaws.keyspaces#TableName", + "traits": { + "smithy.api#documentation": "

The name of the source table.

", + "smithy.api#required": {} + } + }, + "targetKeyspaceName": { + "target": "com.amazonaws.keyspaces#KeyspaceName", + "traits": { + "smithy.api#documentation": "

The name of the target keyspace.

", + "smithy.api#required": {} + } + }, + "targetTableName": { + "target": "com.amazonaws.keyspaces#TableName", + "traits": { + "smithy.api#documentation": "

The name of the target table.

", + "smithy.api#required": {} + } + }, + "restoreTimestamp": { + "target": "com.amazonaws.keyspaces#Timestamp", + "traits": { + "smithy.api#documentation": "

The restore timestamp in ISO 8601 format.

" + } + }, + "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

• 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": "

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": "

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": { + "target": "com.amazonaws.keyspaces#TagList", + "traits": { + "smithy.api#documentation": "

A list of key-value pair tags to be\n attached to the restored table.

\n

For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer\n Guide.

" + } + } + } + }, + "com.amazonaws.keyspaces#RestoreTableResponse": { + "type": "structure", + "members": { + "restoredTableARN": { + "target": "com.amazonaws.keyspaces#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the restored table.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.keyspaces#SchemaDefinition": { + "type": "structure", + "members": { + "allColumns": { + "target": "com.amazonaws.keyspaces#ColumnDefinitionList", + "traits": { + "smithy.api#documentation": "

The regular columns of the table.

", + "smithy.api#required": {} + } + }, + "partitionKeys": { + "target": "com.amazonaws.keyspaces#PartitionKeyList", + "traits": { + "smithy.api#documentation": "

The columns that are part of the partition key of the table .

", + "smithy.api#required": {} + } + }, + "clusteringKeys": { + "target": "com.amazonaws.keyspaces#ClusteringKeyList", + "traits": { + "smithy.api#documentation": "

The columns that are part of the clustering key of the table.

" + } + }, + "staticColumns": { + "target": "com.amazonaws.keyspaces#StaticColumnList", + "traits": { + "smithy.api#documentation": "

The columns that have been defined as STATIC. Static columns store values that are shared by all rows in the same partition.

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

Describes the schema of the table.

" + } + }, + "com.amazonaws.keyspaces#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ServiceQuotaExceededException", + "httpResponseCode": 402 + }, + "smithy.api#documentation": "

The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer\n Guide.

", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.keyspaces#SortOrder": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ASC", + "name": "ASC" + }, + { + "value": "DESC", + "name": "DESC" + } + ] + } + }, + "com.amazonaws.keyspaces#StaticColumn": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.keyspaces#GenericString", + "traits": { + "smithy.api#documentation": "

The name of the static column.

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

The static columns of the table. Static columns store values that are shared by all rows in the same partition.

" + } + }, + "com.amazonaws.keyspaces#StaticColumnList": { + "type": "list", + "member": { + "target": "com.amazonaws.keyspaces#StaticColumn" + } + }, + "com.amazonaws.keyspaces#TableName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 48 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9_]{1,47}$" + } + }, + "com.amazonaws.keyspaces#TableStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "CREATING", + "name": "CREATING" + }, + { + "value": "UPDATING", + "name": "UPDATING" + }, + { + "value": "DELETING", + "name": "DELETING" + }, + { + "value": "DELETED", + "name": "DELETED" + }, + { + "value": "RESTORING", + "name": "RESTORING" + }, + { + "value": "INACCESSIBLE_ENCRYPTION_CREDENTIALS", + "name": "INACCESSIBLE_ENCRYPTION_CREDENTIALS" + } + ] + } + }, + "com.amazonaws.keyspaces#TableSummary": { + "type": "structure", + "members": { + "keyspaceName": { + "target": "com.amazonaws.keyspaces#KeyspaceName", + "traits": { + "smithy.api#documentation": "

The name of the keyspace that the table is stored in.

", + "smithy.api#required": {} + } + }, + "tableName": { + "target": "com.amazonaws.keyspaces#TableName", + "traits": { + "smithy.api#documentation": "

The name of the table.

", + "smithy.api#required": {} + } + }, + "resourceArn": { + "target": "com.amazonaws.keyspaces#ARN", + "traits": { + "smithy.api#documentation": "

The unique identifier of the table in the format of an Amazon Resource Name (ARN).

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

Returns the name of the specified table, the keyspace it is stored in, and the unique identifier in the format of an Amazon Resource Name (ARN).

" + } + }, + "com.amazonaws.keyspaces#TableSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.keyspaces#TableSummary" + } + }, + "com.amazonaws.keyspaces#Tag": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.keyspaces#TagKey", + "traits": { + "smithy.api#documentation": "

The key of the tag. Tag keys are case sensitive. Each Amazon Keyspaces resource can only have up to one tag with the same key. If you try to add an \n existing tag (same key), the existing tag value will be updated to the new value.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.keyspaces#TagValue", + "traits": { + "smithy.api#documentation": "

The value of the tag. Tag values are case-sensitive and can be null.

", + "smithy.api#required": {} + } + } + }, + "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.

" + } + }, + "com.amazonaws.keyspaces#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.keyspaces#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.keyspaces#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 60 + } + } + }, + "com.amazonaws.keyspaces#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.keyspaces#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.keyspaces#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.keyspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.keyspaces#InternalServerException" + }, + { + "target": "com.amazonaws.keyspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.keyspaces#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.keyspaces#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Associates a set of tags with a Amazon Keyspaces resource. You can then \n activate these user-defined tags so that they appear on the Cost Management Console for cost allocation tracking.\n For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer\n Guide.

\n

For IAM policy examples that show how to control access to Amazon Keyspaces resources based on tags, \n see Amazon Keyspaces resource access based on tags\n in the Amazon Keyspaces Developer Guide.

" + } + }, + "com.amazonaws.keyspaces#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.keyspaces#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Keyspaces resource to which to add tags.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.keyspaces#TagList", + "traits": { + "smithy.api#documentation": "

The tags to be assigned to the Amazon Keyspaces resource.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.keyspaces#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.keyspaces#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.keyspaces#ThroughputMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PAY_PER_REQUEST", + "name": "PAY_PER_REQUEST" + }, + { + "value": "PROVISIONED", + "name": "PROVISIONED" + } + ] + } + }, + "com.amazonaws.keyspaces#TimeToLive": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.keyspaces#TimeToLiveStatus", + "traits": { + "smithy.api#documentation": "

Shows how to enable custom Time to Live (TTL) settings for the specified table.

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

Enable custom Time to Live (TTL) settings for rows and columns without setting a TTL default for the specified table.

\n

For more information, see Enabling TTL on tables in the Amazon Keyspaces Developer\n Guide.

" + } + }, + "com.amazonaws.keyspaces#TimeToLiveStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ENABLED", + "name": "ENABLED" + } + ] + } + }, + "com.amazonaws.keyspaces#Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.keyspaces#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.keyspaces#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.keyspaces#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.keyspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.keyspaces#ConflictException" + }, + { + "target": "com.amazonaws.keyspaces#InternalServerException" + }, + { + "target": "com.amazonaws.keyspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.keyspaces#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.keyspaces#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the association of tags from a Amazon Keyspaces resource.

" + } + }, + "com.amazonaws.keyspaces#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.keyspaces#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Keyspaces resource that the tags will be removed from. This value is an Amazon Resource Name (ARN).

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.keyspaces#TagList", + "traits": { + "smithy.api#documentation": "

A list of existing tags to be removed from the Amazon Keyspaces resource.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.keyspaces#UntagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.keyspaces#UpdateTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.keyspaces#UpdateTableRequest" + }, + "output": { + "target": "com.amazonaws.keyspaces#UpdateTableResponse" + }, + "errors": [ + { + "target": "com.amazonaws.keyspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.keyspaces#ConflictException" + }, + { + "target": "com.amazonaws.keyspaces#InternalServerException" + }, + { + "target": "com.amazonaws.keyspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.keyspaces#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.keyspaces#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds new columns to the table or updates one of the table's settings, for example\n capacity mode, encryption, point-in-time recovery, or ttl settings.\n Note that you can only update one specific table setting per update operation.

" + } + }, + "com.amazonaws.keyspaces#UpdateTableRequest": { + "type": "structure", + "members": { + "keyspaceName": { + "target": "com.amazonaws.keyspaces#KeyspaceName", + "traits": { + "smithy.api#documentation": "

The name of the keyspace the specified table is stored in.

", + "smithy.api#required": {} + } + }, + "tableName": { + "target": "com.amazonaws.keyspaces#TableName", + "traits": { + "smithy.api#documentation": "

The name of the table.

", + "smithy.api#required": {} + } + }, + "addColumns": { + "target": "com.amazonaws.keyspaces#ColumnDefinitionList", + "traits": { + "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

• 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": "

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": "

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

• 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": { + "target": "com.amazonaws.keyspaces#DefaultTimeToLive", + "traits": { + "smithy.api#documentation": "

The default Time to Live setting in seconds for the table.

\n

For more information, see Setting the default TTL value for a table in the Amazon Keyspaces Developer\n Guide.

" + } + } + } + }, + "com.amazonaws.keyspaces#UpdateTableResponse": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.keyspaces#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the modified table.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.keyspaces#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ValidationException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The operation failed due to an invalid or malformed request.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.keyspaces#kmsKeyARN": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5096 + } + } + } + } +} diff --git a/aws/sdk/aws-models/lambda.json b/aws/sdk/aws-models/lambda.json index a5ac4587e8..925a05e05c 100644 --- a/aws/sdk/aws-models/lambda.json +++ b/aws/sdk/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/aws/sdk/aws-models/lightsail.json b/aws/sdk/aws-models/lightsail.json index efa8af27d1..7b61e4d6b8 100644 --- a/aws/sdk/aws-models/lightsail.json +++ b/aws/sdk/aws-models/lightsail.json @@ -96,12 +96,12 @@ "lastUsed": { "target": "com.amazonaws.lightsail#AccessKeyLastUsed", "traits": { - "smithy.api#documentation": "

An object that describes the last time the access key was used.

\n\n \n

This object does not include data in the response of a CreateBucketAccessKey action. If the access key has not been used, the\n region and serviceName values are N/A, and the\n lastUsedDate value is null.

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

An object that describes the last time the access key was used.

\n\n \n

This object does not include data in the response of a CreateBucketAccessKey action. If the access key has not been used, the\n region and serviceName values are N/A, and the\n lastUsedDate value is null.

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

Describes an access key for an Amazon Lightsail bucket.

\n\n

Access keys grant full programmatic access to the specified bucket and its objects. You\n can have a maximum of two access keys per bucket. Use the CreateBucketAccessKey action to create an access key for a specific bucket. For\n more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

\n\n \n

The secretAccessKey value is returned only in response to the\n CreateBucketAccessKey action. You can get a secret access key only when you\n first create an access key; you cannot get the secret access key later. If you lose the\n secret access key, you must create a new access key.

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

Describes an access key for an Amazon Lightsail bucket.

\n\n

Access keys grant full programmatic access to the specified bucket and its objects. You\n can have a maximum of two access keys per bucket. Use the CreateBucketAccessKey action to create an access key for a specific bucket. For\n more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

\n\n \n

The secretAccessKey value is returned only in response to the\n CreateBucketAccessKey action. You can get a secret access key only when you\n first create an access key; you cannot get the secret access key later. If you lose the\n secret access key, you must create a new access key.

\n " } }, "com.amazonaws.lightsail#AccessKeyLastUsed": { @@ -127,7 +127,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the last time an access key was used.

\n\n \n

This object does not include data in the response of a CreateBucketAccessKey action.

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

Describes the last time an access key was used.

\n\n \n

This object does not include data in the response of a CreateBucketAccessKey action.

\n " } }, "com.amazonaws.lightsail#AccessKeyList": { @@ -1130,7 +1130,7 @@ "bundleId": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The ID of the bundle currently applied to the bucket.

\n\n

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a\n bucket.

\n\n

Use the UpdateBucketBundle action to change the bundle of a\n bucket.

" + "smithy.api#documentation": "

The ID of the bundle currently applied to the bucket.

\n\n

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a\n bucket.

\n\n

Use the UpdateBucketBundle action to change the\n bundle of a bucket.

" } }, "createdAt": { @@ -1175,7 +1175,7 @@ "ableToUpdateBundle": { "target": "com.amazonaws.lightsail#boolean", "traits": { - "smithy.api#documentation": "

Indicates whether the bundle that is currently applied to a bucket can be changed to\n another bundle.

\n\n

You can update a bucket's bundle only one time within a monthly AWS billing\n cycle.

\n\n

Use the UpdateBucketBundle action to change a bucket's bundle.

" + "smithy.api#documentation": "

Indicates whether the bundle that is currently applied to a bucket can be changed to\n another bundle.

\n\n

You can update a bucket's bundle only one time within a monthly AWS billing\n cycle.

\n\n

Use the UpdateBucketBundle action to change a\n bucket's bundle.

" } }, "readonlyAccessAccounts": { @@ -1187,7 +1187,7 @@ "resourcesReceivingAccess": { "target": "com.amazonaws.lightsail#AccessReceiverList", "traits": { - "smithy.api#documentation": "

An array of objects that describe Lightsail instances that have access to the\n bucket.

\n\n

Use the SetResourceAccessForBucket action to update the instances that\n have access to a bucket.

" + "smithy.api#documentation": "

An array of objects that describe Lightsail instances that have access to the\n bucket.

\n\n

Use the SetResourceAccessForBucket\n action to update the instances that have access to a bucket.

" } }, "state": { @@ -1462,7 +1462,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the per-path cache behavior of an Amazon Lightsail content delivery network (CDN)\n distribution.

\n

A per-path cache behavior is used to override, or add an exception to, the default cache\n behavior of a distribution. For example, if the cacheBehavior is set to\n cache, then a per-path cache behavior can be used to specify a directory, file,\n or file type that your distribution will cache. Alternately, if the distribution's\n cacheBehavior is dont-cache, then a per-path cache behavior can be\n used to specify a directory, file, or file type that your distribution will not cache.

\n

if the cacheBehavior's behavior is set to 'cache', then

" + "smithy.api#documentation": "

Describes the per-path cache behavior of an Amazon Lightsail content delivery network (CDN)\n distribution.

\n

A per-path cache behavior is used to override, or add an exception to, the default cache\n behavior of a distribution. For example, if the cacheBehavior is set to\n cache, then a per-path cache behavior can be used to specify a directory, file,\n or file type that your distribution will cache. Alternately, if the distribution's\n cacheBehavior is dont-cache, then a per-path cache behavior can be\n used to specify a directory, file, or file type that your distribution will not cache.

" } }, "com.amazonaws.lightsail#CacheSettings": { @@ -2063,7 +2063,7 @@ "image": { "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The name of the image used for the container.

\n \n

Container images sourced from your Lightsail container service, that are registered and\n stored on your service, start with a colon (:). For example, if your container\n service name is container-service-1, the container image label is\n mystaticsite, and you want to use the third (3) version of the\n registered container image, then you should specify\n :container-service-1.mystaticsite.3. To use the latest version of a container\n image, specify latest instead of a version number (for example,\n :container-service-1.mystaticsite.latest). Lightsail will automatically use\n the highest numbered version of the registered container image.

\n \n

Container images sourced from a public registry like Docker Hub don't start with a colon.\n For example, nginx:latest or nginx.

" + "smithy.api#documentation": "

The name of the image used for the container.

\n\n

Container images sourced from your Lightsail container service, that are registered and\n stored on your service, start with a colon (:). For example, if your container\n service name is container-service-1, the container image label is\n mystaticsite, and you want to use the third (3) version of the\n registered container image, then you should specify\n :container-service-1.mystaticsite.3. To use the latest version of a container\n image, specify latest instead of a version number (for example,\n :container-service-1.mystaticsite.latest). Lightsail will automatically use\n the highest numbered version of the registered container image.

\n\n

Container images sourced from a public registry like Docker Hub don't start with a colon.\n For example, nginx:latest or nginx.

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

Creates a new access key for the specified Amazon Lightsail bucket. Access keys consist of\n an access key ID and corresponding secret access key.

\n\n

Access keys grant full programmatic access to the specified bucket and its objects. You\n can have a maximum of two access keys per bucket. Use the GetBucketAccessKeys action to get a list of current access keys for a specific bucket. For more information\n about access keys, see Creating access keys for a bucket in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

\n\n \n

The secretAccessKey value is returned only in response to the\n CreateBucketAccessKey action. You can get a secret access key only when you\n first create an access key; you cannot get the secret access key later. If you lose the\n secret access key, you must create a new access key.

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

Creates a new access key for the specified Amazon Lightsail bucket. Access keys consist of\n an access key ID and corresponding secret access key.

\n\n

Access keys grant full programmatic access to the specified bucket and its objects. You\n can have a maximum of two access keys per bucket. Use the GetBucketAccessKeys action to get a list of current access keys for a specific bucket. For more\n information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

\n\n \n

The secretAccessKey value is returned only in response to the\n CreateBucketAccessKey action. You can get a secret access key only when you\n first create an access key; you cannot get the secret access key later. If you lose the\n secret access key, you must create a new access key.

\n ", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/CreateBucketAccessKey", @@ -2986,14 +2986,14 @@ "bundleId": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The ID of the bundle to use for the bucket.

\n\n

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a\n bucket.

\n\n

Use the GetBucketBundles action to get a list of bundle IDs that you can\n specify.

\n\n

Use the UpdateBucketBundle action to change the bundle after the bucket\n is created.

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

The ID of the bundle to use for the bucket.

\n\n

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a\n bucket.

\n\n

Use the GetBucketBundles action to get a list of\n bundle IDs that you can specify.

\n\n

Use the UpdateBucketBundle action to change the\n bundle after the bucket is created.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.lightsail#TagList", "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the bucket during creation.

\n\n

Use the TagResource action to tag the bucket after it's created.

" + "smithy.api#documentation": "

The tag keys and optional values to add to the bucket during creation.

\n\n

Use the TagResource action to tag the bucket after it's\n created.

" } }, "enableObjectVersioning": { @@ -3774,7 +3774,7 @@ "origin": { "target": "com.amazonaws.lightsail#InputOrigin", "traits": { - "smithy.api#documentation": "

An object that describes the origin resource for the distribution, such as a Lightsail\n instance or load balancer.

\n

The distribution pulls, caches, and serves content from the origin.

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

An object that describes the origin resource for the distribution, such as a Lightsail\n instance, bucket, or load balancer.

\n

The distribution pulls, caches, and serves content from the origin.

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

Creates an SSH key pair.

\n

The create key pair operation supports tag-based access control via request\n tags. For more information, see the Amazon Lightsail Developer Guide.

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

Creates a custom SSH key pair that you can use with an Amazon Lightsail\n instance.

\n \n

Use the DownloadDefaultKeyPair action to create a Lightsail default key\n pair in an Amazon Web Services Region where a default key pair does not currently\n exist.

\n \n

The create key pair operation supports tag-based access control via request\n tags. For more information, see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/CreateKeyPair", @@ -5112,7 +5112,7 @@ "accessKeyId": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The ID of the access key to delete.

\n\n

Use the GetBucketAccessKeys action to get a list of access key IDs that\n you can specify.

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

The ID of the access key to delete.

\n\n

Use the GetBucketAccessKeys action to get a\n list of access key IDs that you can specify.

", "smithy.api#required": {} } } @@ -5135,14 +5135,14 @@ "bucketName": { "target": "com.amazonaws.lightsail#BucketName", "traits": { - "smithy.api#documentation": "

The name of the bucket to delete.

\n\n

Use the GetBuckets action to get a list of bucket names that you can\n specify.

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

The name of the bucket to delete.

\n\n

Use the GetBuckets action to get a list of bucket names\n that you can specify.

", "smithy.api#required": {} } }, "forceDelete": { "target": "com.amazonaws.lightsail#boolean", "traits": { - "smithy.api#documentation": "

A Boolean value that indicates whether to force delete the bucket.

\n\n

You must force delete the bucket if it has one of the following conditions:

\n
    \n
  • \n

    The bucket is the origin of a distribution.

    \n
    • \n
  • \n

    The bucket has instances that were granted access to it using the SetResourceAccessForBucket action.

    \n
    • \n
  • \n

    The bucket has objects.

    \n
    • \n
  • \n

    The bucket has access keys.

    \n
    • \n
\n\n \n

Force deleting a bucket might impact other resources that rely on the bucket, such as\n instances, distributions, or software that use the issued access keys.

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

A Boolean value that indicates whether to force delete the bucket.

\n\n

You must force delete the bucket if it has one of the following conditions:

\n
    \n
  • \n

    The bucket is the origin of a distribution.

    \n
    • \n
  • \n

    The bucket has instances that were granted access to it using the SetResourceAccessForBucket action.

    \n
    • \n
  • \n

    The bucket has objects.

    \n
    • \n
  • \n

    The bucket has access keys.

    \n
    • \n
\n\n \n

Force deleting a bucket might impact other resources that rely on the bucket, such as\n instances, distributions, or software that use the issued access keys.

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

Deletes a specific SSH key pair.

\n \n\n

The delete key pair operation supports tag-based access control via resource\n tags applied to the resource identified by key pair name. For more information,\n see the Amazon Lightsail Developer Guide.

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

Deletes the specified key pair by removing the public key from Amazon Lightsail.

\n

You can delete key pairs that were created using the ImportKeyPair and\n CreateKeyPair actions, as well as the Lightsail default key pair. A new default\n key pair will not be created unless you launch an instance without specifying a custom key\n pair, or you call the DownloadDefaultKeyPair API.

\n\n

The delete key pair operation supports tag-based access control via resource\n tags applied to the resource identified by key pair name. For more information,\n see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/DeleteKeyPair", @@ -5890,6 +5890,12 @@ "smithy.api#documentation": "

The name of the key pair to delete.

", "smithy.api#required": {} } + }, + "expectedFingerprint": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The RSA fingerprint of the Lightsail default key pair to delete.

\n \n

The expectedFingerprint parameter is required only when specifying to\n delete a Lightsail default key pair.

\n " + } } } }, @@ -7213,7 +7219,7 @@ } ], "traits": { - "smithy.api#documentation": "

Downloads the default SSH key pair from the user's account.

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

Downloads the regional Amazon Lightsail default key pair.

\n

This action also creates a Lightsail default key pair if a default key pair\n does not currently exist in the Amazon Web Services Region.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/DownloadDefaultKeyPair", @@ -7239,6 +7245,12 @@ "traits": { "smithy.api#documentation": "

A base64-encoded RSA private key.

" } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the default key pair was created.

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

Returns the existing access key IDs for the specified Amazon Lightsail bucket.

\n\n \n

This action does not return the secret access key value of an access key. You can get a\n secret access key only when you create it from the response of the CreateBucketAccessKey action. If you lose the secret access key, you must\n create a new access key.

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

Returns the existing access key IDs for the specified Amazon Lightsail bucket.

\n\n \n

This action does not return the secret access key value of an access key. You can get a\n secret access key only when you create it from the response of the CreateBucketAccessKey action. If you lose the secret access key, you must create\n a new access key.

\n ", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetBucketAccessKeys", @@ -7935,7 +7947,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the bundles that you can apply to a Amazon Lightsail bucket.

\n\n

The bucket bundle specifies the monthly cost, storage quota, and data transfer quota for a\n bucket.

\n\n

Use the UpdateBucketBundle action to update the bundle for a\n bucket.

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

Returns the bundles that you can apply to a Amazon Lightsail bucket.

\n\n

The bucket bundle specifies the monthly cost, storage quota, and data transfer quota for a\n bucket.

\n\n

Use the UpdateBucketBundle action to update the\n bundle for a bucket.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetBucketBundles", @@ -8122,7 +8134,7 @@ "includeConnectedResources": { "target": "com.amazonaws.lightsail#boolean", "traits": { - "smithy.api#documentation": "

A Boolean value that indicates whether to include Lightsail instances that were given\n access to the bucket using the SetResourceAccessForBucket action.

" + "smithy.api#documentation": "

A Boolean value that indicates whether to include Lightsail instances that were given\n access to the bucket using the SetResourceAccessForBucket\n action.

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

Returns all export snapshot records created as a result of the export\n snapshot operation.

\n

An export snapshot record can be used to create a new Amazon EC2 instance and its related\n resources with the CreateCloudFormationStack action.

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

Returns all export snapshot records created as a result of the export\n snapshot operation.

\n

An export snapshot record can be used to create a new Amazon EC2 instance and its related\n resources with the CreateCloudFormationStack\n action.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetExportSnapshotRecords", @@ -10307,6 +10319,12 @@ "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetKeyPairs request. If your results\n are paginated, the response will return a next page token that you can specify as the page\n token in a subsequent request.

" } + }, + "includeDefaultKeyPair": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that indicates whether to include the default key pair in the response of\n your request.

" + } } } }, @@ -12212,7 +12230,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the origin resource of an Amazon Lightsail content delivery network (CDN)\n distribution.

\n

An origin can be a Lightsail instance or load balancer. A distribution pulls content\n from an origin, caches it, and serves it to viewers via a worldwide network of edge\n servers.

" + "smithy.api#documentation": "

Describes the origin resource of an Amazon Lightsail content delivery network (CDN)\n distribution.

\n

An origin can be a Lightsail instance, bucket, or load balancer. A distribution pulls\n content from an origin, caches it, and serves it to viewers via a worldwide network of edge\n servers.

" } }, "com.amazonaws.lightsail#Instance": { @@ -13270,7 +13288,7 @@ "origin": { "target": "com.amazonaws.lightsail#Origin", "traits": { - "smithy.api#documentation": "

An object that describes the origin resource of the distribution, such as a Lightsail\n instance or load balancer.

\n

The distribution pulls, caches, and serves content from the origin.

" + "smithy.api#documentation": "

An object that describes the origin resource of the distribution, such as a Lightsail\n instance, bucket, or load balancer.

\n

The distribution pulls, caches, and serves content from the origin.

" } }, "originPublicDNS": { @@ -15476,7 +15494,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the origin resource of an Amazon Lightsail content delivery network (CDN)\n distribution.

\n

An origin can be a Lightsail instance or load balancer. A distribution pulls content\n from an origin, caches it, and serves it to viewers via a worldwide network of edge\n servers.

" + "smithy.api#documentation": "

Describes the origin resource of an Amazon Lightsail content delivery network (CDN)\n distribution.

\n

An origin can be a Lightsail instance, bucket, or load balancer. A distribution pulls\n content from an origin, caches it, and serves it to viewers via a worldwide network of edge\n servers.

" } }, "com.amazonaws.lightsail#OriginProtocolPolicyEnum": { @@ -18325,7 +18343,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket.

\n\n

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a\n bucket. You can update a bucket's bundle only one time within a monthly AWS billing cycle. To\n determine if you can update a bucket's bundle, use the GetBuckets action.\n The ableToUpdateBundle parameter in the response will indicate whether you can\n currently update a bucket's bundle.

\n\n

Update a bucket's bundle if it's consistently going over its storage space or data\n transfer quota, or if a bucket's usage is consistently in the lower range of its storage space\n or data transfer quota. Due to the unpredictable usage fluctuations that a bucket might\n experience, we strongly recommend that you update a bucket's bundle only as a long-term\n strategy, instead of as a short-term, monthly cost-cutting measure. Choose a bucket bundle\n that will provide the bucket with ample storage space and data transfer for a long time to\n come.

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

Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket.

\n\n

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a\n bucket. You can update a bucket's bundle only one time within a monthly AWS billing cycle. To\n determine if you can update a bucket's bundle, use the GetBuckets action. The\n ableToUpdateBundle parameter in the response will indicate whether you can\n currently update a bucket's bundle.

\n\n

Update a bucket's bundle if it's consistently going over its storage space or data\n transfer quota, or if a bucket's usage is consistently in the lower range of its storage space\n or data transfer quota. Due to the unpredictable usage fluctuations that a bucket might\n experience, we strongly recommend that you update a bucket's bundle only as a long-term\n strategy, instead of as a short-term, monthly cost-cutting measure. Choose a bucket bundle\n that will provide the bucket with ample storage space and data transfer for a long time to\n come.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/UpdateBucketBundle", @@ -18346,7 +18364,7 @@ "bundleId": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The ID of the new bundle to apply to the bucket.

\n\n

Use the GetBucketBundles action to get a list of bundle IDs that you can\n specify.

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

The ID of the new bundle to apply to the bucket.

\n\n

Use the GetBucketBundles action to get a list of\n bundle IDs that you can specify.

", "smithy.api#required": {} } } @@ -18610,7 +18628,7 @@ "origin": { "target": "com.amazonaws.lightsail#InputOrigin", "traits": { - "smithy.api#documentation": "

An object that describes the origin resource for the distribution, such as a Lightsail\n instance or load balancer.

\n

The distribution pulls, caches, and serves content from the origin.

" + "smithy.api#documentation": "

An object that describes the origin resource for the distribution, such as a Lightsail\n instance, bucket, or load balancer.

\n

The distribution pulls, caches, and serves content from the origin.

" } }, "defaultCacheBehavior": { diff --git a/aws/sdk/aws-models/location.json b/aws/sdk/aws-models/location.json index 1e8de0ffff..9cb06b7e83 100644 --- a/aws/sdk/aws-models/location.json +++ b/aws/sdk/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
  • \n

    VectorEsriDarkGrayCanvas – Ubuntu Medium Italic | Ubuntu\n Medium | Ubuntu Italic | Ubuntu Regular |\n Ubuntu Bold\n

    \n
    • \n
  • \n

    VectorEsriLightGrayCanvas – Ubuntu Italic | Ubuntu\n Regular | Ubuntu Light | Ubuntu Bold\n

    \n
    • \n
  • \n

    VectorEsriTopographic – Noto Sans Italic | Noto Sans\n Regular | Noto Sans Bold | Noto Serif\n Regular | Roboto Condensed Light Italic\n

    \n
    • \n
  • \n

    VectorEsriStreets – Arial Regular | Arial Italic |\n Arial Bold\n

    \n
    • \n
  • \n

    VectorEsriNavigation – Arial Regular | Arial Italic\n | Arial Bold\n

    \n
    • \n
\n

Valid font stacks for HERE Technologies styles:

\n
    \n
  • \n

    VectorHereBerlin – Fira GO Regular | Fira GO\n Bold\n

    \n
    • \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
  • \n

    VectorEsriDarkGrayCanvas – Ubuntu Medium Italic | Ubuntu\n Medium | Ubuntu Italic | Ubuntu Regular |\n Ubuntu Bold\n

    \n
    • \n
  • \n

    VectorEsriLightGrayCanvas – Ubuntu Italic | Ubuntu\n Regular | Ubuntu Light | Ubuntu Bold\n

    \n
    • \n
  • \n

    VectorEsriTopographic – Noto Sans Italic | Noto Sans\n Regular | Noto Sans Bold | Noto Serif\n Regular | Roboto Condensed Light Italic\n

    \n
    • \n
  • \n

    VectorEsriStreets – Arial Regular | Arial Italic |\n Arial Bold\n

    \n
    • \n
  • \n

    VectorEsriNavigation – Arial Regular | Arial Italic\n | Arial Bold\n

    \n
    • \n
\n

Valid font stacks for HERE Technologies styles:

\n
    \n
  • \n

    VectorHereBerlin – Fira \n GO Regular | Fira GO Bold\n

    \n
    • \n
  • \n

    VectorHereExplore, VectorHereExploreTruck – Firo GO Italic | \n Fira GO Map | Fira GO Map Bold | Noto Sans CJK \n JP Bold | Noto Sans CJK JP Light | Noto Sans CJK \n JP Regular\n

    \n
    • \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
  • \n

    \n VectorEsriDarkGrayCanvas – The Esri Dark Gray Canvas map style. A\n vector basemap with a dark gray, neutral background with minimal colors, labels,\n and features that's designed to draw attention to your thematic content.

    \n
    • \n
  • \n

    \n RasterEsriImagery – The Esri Imagery map style. A raster basemap\n that provides one meter or better satellite and aerial imagery in many parts of\n the world and lower resolution satellite imagery worldwide.

    \n
    • \n
  • \n

    \n VectorEsriLightGrayCanvas – The Esri Light Gray Canvas map style,\n which provides a detailed vector basemap with a light gray, neutral background\n style with minimal colors, labels, and features that's designed to draw\n attention to your thematic content.

    \n
    • \n
  • \n

    \n VectorEsriTopographic – The Esri Light map style, which provides\n a detailed vector basemap with a classic Esri map style.

    \n
    • \n
  • \n

    \n VectorEsriStreets – The Esri World Streets map style, which\n provides a detailed vector basemap for the world symbolized with a classic Esri\n street map style. The vector tile layer is similar in content and style to the\n World Street Map raster map.

    \n
    • \n
  • \n

    \n VectorEsriNavigation – The Esri World Navigation map style, which\n provides a detailed basemap for the world symbolized with a custom navigation\n map style that's designed for use during the day in mobile devices.

    \n
    • \n
\n

Valid HERE\n Technologies map styles:

\n
    \n
  • \n

    \n VectorHereBerlin – The HERE Berlin map style is a high contrast\n detailed base map of the world that blends 3D and 2D rendering.

    \n \n

    When using HERE as your data provider, and selecting the Style\n VectorHereBerlin, you may not use HERE Technologies maps\n for Asset Management. See the AWS Service Terms\n for Amazon Location Service.

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

Specifies the map style selected from an available data provider.

\n

Valid Esri map styles:

\n
    \n
  • \n

    \n VectorEsriDarkGrayCanvas – The Esri Dark Gray Canvas map style. A\n vector basemap with a dark gray, neutral background with minimal colors, labels,\n and features that's designed to draw attention to your thematic content.

    \n
    • \n
  • \n

    \n RasterEsriImagery – The Esri Imagery map style. A raster basemap\n that provides one meter or better satellite and aerial imagery in many parts of\n the world and lower resolution satellite imagery worldwide.

    \n
    • \n
  • \n

    \n VectorEsriLightGrayCanvas – The Esri Light Gray Canvas map style,\n which provides a detailed vector basemap with a light gray, neutral background\n style with minimal colors, labels, and features that's designed to draw\n attention to your thematic content.

    \n
    • \n
  • \n

    \n VectorEsriTopographic – The Esri Light map style, which provides\n a detailed vector basemap with a classic Esri map style.

    \n
    • \n
  • \n

    \n VectorEsriStreets – The Esri World Streets map style, which\n provides a detailed vector basemap for the world symbolized with a classic Esri\n street map style. The vector tile layer is similar in content and style to the\n World Street Map raster map.

    \n
    • \n
  • \n

    \n VectorEsriNavigation – The Esri World Navigation map style, which\n provides a detailed basemap for the world symbolized with a custom navigation\n map style that's designed for use during the day in mobile devices.

    \n
    • \n
\n

Valid HERE\n Technologies map styles:

\n
    \n
  • \n

    \n VectorHereBerlin – The HERE Berlin map style is a high contrast\n detailed base map of the world that blends 3D and 2D rendering.

    \n
    • \n
  • \n

    \n VectorHereExplore – A default HERE map style containing a \n neutral, global map and its features including roads, buildings, landmarks, \n and water features. It also now includes a fully designed map of Japan.

    \n
    • \n
  • \n

    \n VectorHereExploreTruck – A global map containing truck \n restrictions and attributes (e.g. width / height / HAZMAT) symbolized with \n highlighted segments and icons on top of HERE Explore to support use cases \n within transport and logistics.

    \n
    • \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/aws/sdk/aws-models/macie.json b/aws/sdk/aws-models/macie.json index 05f7f6c7f4..bd9c3c4b71 100644 --- a/aws/sdk/aws-models/macie.json +++ b/aws/sdk/aws-models/macie.json @@ -32,7 +32,7 @@ "com.amazonaws.macie#AWSAccountId": { "type": "string", "traits": { - "smithy.api#pattern": "[0-9]{12}" + "smithy.api#pattern": "^[0-9]{12}$" } }, "com.amazonaws.macie#AccessDeniedException": { @@ -46,7 +46,7 @@ } }, "traits": { - "smithy.api#documentation": "

You do not have required permissions to access the requested resource.

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

(Discontinued) You do not have required permissions to access the requested resource.

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

Associates a specified AWS account with Amazon Macie Classic as a member\n account.

" + "smithy.api#documentation": "

(Discontinued) Associates a specified Amazon Web Services account with Amazon Macie Classic as a member\n account.

" } }, "com.amazonaws.macie#AssociateMemberAccountRequest": { @@ -76,7 +76,7 @@ "memberAccountId": { "target": "com.amazonaws.macie#AWSAccountId", "traits": { - "smithy.api#documentation": "

The ID of the AWS account that you want to associate with Amazon Macie Classic as a\n member account.

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

(Discontinued) The ID of the Amazon Web Services account that you want to associate with Amazon Macie\n Classic as a member account.

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

Associates specified S3 resources with Amazon Macie Classic for monitoring and data\n classification. If memberAccountId isn't specified, the action associates specified S3\n resources with Macie Classic for the current Macie Classic administrator account. If memberAccountId is specified,\n the action associates specified S3 resources with Macie Classic for the specified member\n account.

" + "smithy.api#documentation": "

(Discontinued) Associates specified S3 resources with Amazon Macie Classic for\n monitoring and data classification. If memberAccountId isn't specified, the action associates\n specified S3 resources with Macie Classic for the current Macie Classic administrator account.\n If memberAccountId is specified, the action associates specified S3 resources with Macie\n Classic for the specified member account.

" } }, "com.amazonaws.macie#AssociateS3ResourcesRequest": { @@ -114,13 +114,13 @@ "memberAccountId": { "target": "com.amazonaws.macie#AWSAccountId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon Macie Classic member account whose resources you want to associate\n with Macie Classic.

" + "smithy.api#documentation": "

(Discontinued) The ID of the Amazon Macie Classic member account whose resources you\n want to associate with Macie Classic.

" } }, "s3Resources": { "target": "com.amazonaws.macie#S3ResourcesClassification", "traits": { - "smithy.api#documentation": "

The S3 resources that you want to associate with Amazon Macie Classic for monitoring\n and data classification.

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

(Discontinued) The S3 resources that you want to associate with Amazon Macie Classic\n for monitoring and data classification.

", "smithy.api#required": {} } } @@ -132,7 +132,7 @@ "failedS3Resources": { "target": "com.amazonaws.macie#FailedS3Resources", "traits": { - "smithy.api#documentation": "

S3 resources that couldn't be associated with Amazon Macie Classic. An error code and\n an error message are provided for each failed item.

" + "smithy.api#documentation": "

(Discontinued) S3 resources that couldn't be associated with Amazon Macie Classic. An\n error code and an error message are provided for each failed item.

" } } } @@ -152,20 +152,20 @@ "oneTime": { "target": "com.amazonaws.macie#S3OneTimeClassificationType", "traits": { - "smithy.api#documentation": "

A one-time classification of all of the existing objects in a specified S3 bucket.\n

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

(Discontinued) A one-time classification of all of the existing objects in a specified\n S3 bucket.

", "smithy.api#required": {} } }, "continuous": { "target": "com.amazonaws.macie#S3ContinuousClassificationType", "traits": { - "smithy.api#documentation": "

A continuous classification of the objects that are added to a specified S3 bucket.\n Amazon Macie Classic begins performing continuous classification after a bucket is\n successfully associated with Macie Classic.

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

(Discontinued) A continuous classification of the objects that are added to a specified\n S3 bucket. Amazon Macie Classic begins performing continuous classification after a bucket is\n successfully associated with Macie Classic.

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

The classification type that Amazon Macie Classic applies to the associated S3\n resources.

" + "smithy.api#documentation": "

(Discontinued) The classification type that Amazon Macie Classic applies to the\n associated S3 resources.

" } }, "com.amazonaws.macie#ClassificationTypeUpdate": { @@ -174,18 +174,18 @@ "oneTime": { "target": "com.amazonaws.macie#S3OneTimeClassificationType", "traits": { - "smithy.api#documentation": "

A one-time classification of all of the existing objects in a specified S3 bucket.\n

" + "smithy.api#documentation": "

(Discontinued) A one-time classification of all of the existing objects in a specified\n S3 bucket.

" } }, "continuous": { "target": "com.amazonaws.macie#S3ContinuousClassificationType", "traits": { - "smithy.api#documentation": "

A continuous classification of the objects that are added to a specified S3 bucket.\n Amazon Macie Classic begins performing continuous classification after a bucket is\n successfully associated with Macie Classic.

" + "smithy.api#documentation": "

(Discontinued) A continuous classification of the objects that are added to a specified\n S3 bucket. Amazon Macie Classic begins performing continuous classification after a bucket is\n successfully associated with Macie Classic.

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

The classification type that Amazon Macie Classic applies to the associated S3\n resources. At least one of the classification types (oneTime or continuous) must be specified.\n

" + "smithy.api#documentation": "

(Discontinued) The classification type that Amazon Macie Classic applies to the\n associated S3 resources. At least one of the classification types (oneTime or continuous) must\n be specified.

" } }, "com.amazonaws.macie#DisassociateMemberAccount": { @@ -202,7 +202,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes the specified member account from Amazon Macie Classic.

" + "smithy.api#documentation": "

(Discontinued) Removes the specified member account from Amazon Macie\n Classic.

" } }, "com.amazonaws.macie#DisassociateMemberAccountRequest": { @@ -211,7 +211,7 @@ "memberAccountId": { "target": "com.amazonaws.macie#AWSAccountId", "traits": { - "smithy.api#documentation": "

The ID of the member account that you want to remove from Amazon Macie\n Classic.

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

(Discontinued) The ID of the member account that you want to remove from Amazon Macie\n Classic.

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

Removes specified S3 resources from being monitored by Amazon Macie Classic. If\n memberAccountId isn't specified, the action removes specified S3 resources from Macie Classic\n for the current Macie Classic administrator account. If memberAccountId is specified, the action removes specified\n S3 resources from Macie Classic for the specified member account.

" + "smithy.api#documentation": "

(Discontinued) Removes specified S3 resources from being monitored by Amazon Macie\n Classic. If memberAccountId isn't specified, the action removes specified S3 resources from\n Macie Classic for the current Macie Classic administrator account. If memberAccountId is\n specified, the action removes specified S3 resources from Macie Classic for the specified\n member account.

" } }, "com.amazonaws.macie#DisassociateS3ResourcesRequest": { @@ -246,13 +246,13 @@ "memberAccountId": { "target": "com.amazonaws.macie#AWSAccountId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon Macie Classic member account whose resources you want to remove\n from being monitored by Macie Classic.

" + "smithy.api#documentation": "

(Discontinued) The ID of the Amazon Macie Classic member account whose resources you\n want to remove from being monitored by Macie Classic.

" } }, "associatedS3Resources": { "target": "com.amazonaws.macie#S3Resources", "traits": { - "smithy.api#documentation": "

The S3 resources (buckets or prefixes) that you want to remove from being monitored and\n classified by Amazon Macie Classic.

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

(Discontinued) The S3 resources (buckets or prefixes) that you want to remove from\n being monitored and classified by Amazon Macie Classic.

", "smithy.api#required": {} } } @@ -264,7 +264,7 @@ "failedS3Resources": { "target": "com.amazonaws.macie#FailedS3Resources", "traits": { - "smithy.api#documentation": "

S3 resources that couldn't be removed from being monitored and classified by Amazon\n Macie Classic. An error code and an error message are provided for each failed item.\n

" + "smithy.api#documentation": "

(Discontinued) S3 resources that couldn't be removed from being monitored and\n classified by Amazon Macie Classic. An error code and an error message are provided for each\n failed item.

" } } } @@ -294,24 +294,24 @@ "failedItem": { "target": "com.amazonaws.macie#S3Resource", "traits": { - "smithy.api#documentation": "

The failed S3 resources.

" + "smithy.api#documentation": "

(Discontinued) The failed S3 resources.

" } }, "errorCode": { "target": "com.amazonaws.macie#ErrorCode", "traits": { - "smithy.api#documentation": "

The status code of a failed item.

" + "smithy.api#documentation": "

(Discontinued) The status code of a failed item.

" } }, "errorMessage": { "target": "com.amazonaws.macie#ExceptionMessage", "traits": { - "smithy.api#documentation": "

The error message of a failed item.

" + "smithy.api#documentation": "

(Discontinued) The error message of a failed item.

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

Includes details about the failed S3 resources.

" + "smithy.api#documentation": "

(Discontinued) Includes details about the failed S3 resources.

" } }, "com.amazonaws.macie#FailedS3Resources": { @@ -341,7 +341,7 @@ } }, "traits": { - "smithy.api#documentation": "

Internal server error.

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

(Discontinued) Internal server error.

", "smithy.api#error": "server" } }, @@ -359,7 +359,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request was rejected because an invalid or out-of-range value was supplied for an\n input parameter.

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

(Discontinued) The request was rejected because an invalid or out-of-range value was supplied for an\n input parameter.

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

The request was rejected because it attempted to create resources beyond the current\n AWS account limits. The error code describes the limit exceeded.

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

(Discontinued) The request was rejected because it attempted to create resources beyond the current\n Amazon Web Services account quotas. The error code describes the quota exceeded.

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

Lists all Amazon Macie Classic member accounts for the current Macie Classic administrator account.

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

(Discontinued) Lists all Amazon Macie Classic member accounts for the current Macie\n Classic administrator account.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -412,13 +412,13 @@ "nextToken": { "target": "com.amazonaws.macie#NextToken", "traits": { - "smithy.api#documentation": "

Use this parameter when paginating results. Set the value of this parameter to null on\n your first call to the ListMemberAccounts action. Subsequent calls to the action fill\n nextToken in the request with the value of nextToken from the previous response to continue\n listing data.

" + "smithy.api#documentation": "

(Discontinued) Use this parameter when paginating results. Set the value of this\n parameter to null on your first call to the ListMemberAccounts action. Subsequent calls to the\n action fill nextToken in the request with the value of nextToken from the previous response to\n continue listing data.

" } }, "maxResults": { "target": "com.amazonaws.macie#MaxResults", "traits": { - "smithy.api#documentation": "

Use this parameter to indicate the maximum number of items that you want in the\n response. The default value is 250.

" + "smithy.api#documentation": "

(Discontinued) Use this parameter to indicate the maximum number of items that you want\n in the response. The default value is 250.

" } } } @@ -429,13 +429,13 @@ "memberAccounts": { "target": "com.amazonaws.macie#MemberAccounts", "traits": { - "smithy.api#documentation": "

A list of the Amazon Macie Classic member accounts returned by the action. The current\n Macie Classic administrator account is also included in this list.

" + "smithy.api#documentation": "

(Discontinued) A list of the Amazon Macie Classic member accounts returned by the\n action. The current Macie Classic administrator account is also included in this\n list.

" } }, "nextToken": { "target": "com.amazonaws.macie#NextToken", "traits": { - "smithy.api#documentation": "

When a response is generated, if there is more data to be listed, this parameter is\n present in the response and contains the value to use for the nextToken parameter in a\n subsequent pagination request. If there is no more data to be listed, this parameter is set to\n null.

" + "smithy.api#documentation": "

(Discontinued) When a response is generated, if there is more data to be listed, this\n parameter is present in the response and contains the value to use for the nextToken parameter\n in a subsequent pagination request. If there is no more data to be listed, this parameter is\n set to null.

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

Lists all the S3 resources associated with Amazon Macie Classic. If memberAccountId\n isn't specified, the action lists the S3 resources associated with Macie Classic for\n the current Macie Classic administrator account. If memberAccountId is specified, the action lists the S3 resources\n associated with Macie Classic for the specified member account.

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

(Discontinued) Lists all the S3 resources associated with Amazon Macie Classic. If\n memberAccountId isn't specified, the action lists the S3 resources associated with Macie\n Classic for the current Macie Classic administrator account. If memberAccountId is specified,\n the action lists the S3 resources associated with Macie Classic for the specified member\n account.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -474,19 +474,19 @@ "memberAccountId": { "target": "com.amazonaws.macie#AWSAccountId", "traits": { - "smithy.api#documentation": "

The Amazon Macie Classic member account ID whose associated S3 resources you want to\n list.

" + "smithy.api#documentation": "

(Discontinued) The Amazon Macie Classic member account ID whose associated S3 resources\n you want to list.

" } }, "nextToken": { "target": "com.amazonaws.macie#NextToken", "traits": { - "smithy.api#documentation": "

Use this parameter when paginating results. Set its value to null on your first call to\n the ListS3Resources action. Subsequent calls to the action fill nextToken in the request with\n the value of nextToken from the previous response to continue listing data.

" + "smithy.api#documentation": "

(Discontinued) Use this parameter when paginating results. Set its value to null on\n your first call to the ListS3Resources action. Subsequent calls to the action fill nextToken\n in the request with the value of nextToken from the previous response to continue listing\n data.

" } }, "maxResults": { "target": "com.amazonaws.macie#MaxResults", "traits": { - "smithy.api#documentation": "

Use this parameter to indicate the maximum number of items that you want in the\n response. The default value is 250.

" + "smithy.api#documentation": "

(Discontinued) Use this parameter to indicate the maximum number of items that you want\n in the response. The default value is 250.

" } } } @@ -497,19 +497,34 @@ "s3Resources": { "target": "com.amazonaws.macie#S3ResourcesClassification", "traits": { - "smithy.api#documentation": "

A list of the associated S3 resources returned by the action.

" + "smithy.api#documentation": "

(Discontinued) A list of the associated S3 resources returned by the action.

" } }, "nextToken": { "target": "com.amazonaws.macie#NextToken", "traits": { - "smithy.api#documentation": "

When a response is generated, if there is more data to be listed, this parameter is\n present in the response and contains the value to use for the nextToken parameter in a\n subsequent pagination request. If there is no more data to be listed, this parameter is set to\n null.

" + "smithy.api#documentation": "

(Discontinued) When a response is generated, if there is more data to be listed, this\n parameter is present in the response and contains the value to use for the nextToken parameter\n in a subsequent pagination request. If there is no more data to be listed, this parameter is\n set to null.

" } } } }, "com.amazonaws.macie#MacieService": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Macie", + "arnNamespace": "macie", + "cloudFormationName": "Macie", + "cloudTrailEventSource": "macie.amazonaws.com", + "endpointPrefix": "macie" + }, + "aws.auth#sigv4": { + "name": "macie" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "Amazon Macie Classic\n

Amazon Macie Classic has been discontinued and is no longer available.

\n \n

A new Amazon Macie is now available with significant design improvements and additional\n features, at a lower price and in most Amazon Web Services Regions. We encourage you to take advantage of the\n new and improved features, and benefit from the reduced cost. To learn about features and pricing for the new Macie, see Amazon Macie. To learn how to use the new Macie, see the Amazon Macie User\n Guide.

", + "smithy.api#title": "Amazon Macie" + }, "version": "2017-12-19", "operations": [ { @@ -533,22 +548,7 @@ { "target": "com.amazonaws.macie#UpdateS3Resources" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Macie", - "arnNamespace": "macie", - "cloudFormationName": "Macie", - "cloudTrailEventSource": "macie.amazonaws.com", - "endpointPrefix": "macie" - }, - "aws.auth#sigv4": { - "name": "macie" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Amazon Macie Classic\n

Amazon Macie Classic is a security service that uses machine learning to automatically\n discover, classify, and protect sensitive data in AWS. Macie Classic recognizes sensitive data\n such as personally identifiable information (PII) or intellectual property, and provides you\n with dashboards and alerts that give visibility into how this data is being accessed or moved.\n For more information, see the Amazon Macie\n Classic User Guide.

", - "smithy.api#title": "Amazon Macie" - } + ] }, "com.amazonaws.macie#MaxResults": { "type": "integer", @@ -565,12 +565,12 @@ "accountId": { "target": "com.amazonaws.macie#AWSAccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID of the Amazon Macie Classic member account.

" + "smithy.api#documentation": "

(Discontinued) The Amazon Web Services account ID of the Amazon Macie Classic member account.

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

Contains information about the Amazon Macie Classic member account.

" + "smithy.api#documentation": "

(Discontinued) Contains information about the Amazon Macie Classic member\n account.

" } }, "com.amazonaws.macie#MemberAccounts": { @@ -639,19 +639,19 @@ "bucketName": { "target": "com.amazonaws.macie#BucketName", "traits": { - "smithy.api#documentation": "

The name of the S3 bucket.

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

(Discontinued) The name of the S3 bucket.

", "smithy.api#required": {} } }, "prefix": { "target": "com.amazonaws.macie#Prefix", "traits": { - "smithy.api#documentation": "

The prefix of the S3 bucket.

" + "smithy.api#documentation": "

(Discontinued) The prefix of the S3 bucket.

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

Contains information about the S3 resource. This data type is used as a request\n parameter in the DisassociateS3Resources action and can be used as a response parameter in the\n AssociateS3Resources and UpdateS3Resources actions.

" + "smithy.api#documentation": "

(Discontinued) Contains information about the S3 resource. This data type is used as a\n request parameter in the DisassociateS3Resources action and can be used as a response\n parameter in the AssociateS3Resources and UpdateS3Resources actions.

" } }, "com.amazonaws.macie#S3ResourceClassification": { @@ -660,26 +660,26 @@ "bucketName": { "target": "com.amazonaws.macie#BucketName", "traits": { - "smithy.api#documentation": "

The name of the S3 bucket that you want to associate with Amazon Macie\n Classic.

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

(Discontinued) The name of the S3 bucket that you want to associate with Amazon Macie\n Classic.

", "smithy.api#required": {} } }, "prefix": { "target": "com.amazonaws.macie#Prefix", "traits": { - "smithy.api#documentation": "

The prefix of the S3 bucket that you want to associate with Amazon Macie\n Classic.

" + "smithy.api#documentation": "

(Discontinued) The prefix of the S3 bucket that you want to associate with Amazon Macie\n Classic.

" } }, "classificationType": { "target": "com.amazonaws.macie#ClassificationType", "traits": { - "smithy.api#documentation": "

The classification type that you want to specify for the resource associated with\n Amazon Macie Classic.

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

(Discontinued) The classification type that you want to specify for the resource\n associated with Amazon Macie Classic.

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

The S3 resources that you want to associate with Amazon Macie Classic for monitoring\n and data classification. This data type is used as a request parameter in the\n AssociateS3Resources action and a response parameter in the ListS3Resources action.

" + "smithy.api#documentation": "

(Discontinued) The S3 resources that you want to associate with Amazon Macie Classic\n for monitoring and data classification. This data type is used as a request parameter in the\n AssociateS3Resources action and a response parameter in the ListS3Resources action.

" } }, "com.amazonaws.macie#S3ResourceClassificationUpdate": { @@ -688,26 +688,26 @@ "bucketName": { "target": "com.amazonaws.macie#BucketName", "traits": { - "smithy.api#documentation": "

The name of the S3 bucket whose classification types you want to update.

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

(Discontinued) The name of the S3 bucket whose classification types you want to\n update.

", "smithy.api#required": {} } }, "prefix": { "target": "com.amazonaws.macie#Prefix", "traits": { - "smithy.api#documentation": "

The prefix of the S3 bucket whose classification types you want to update.

" + "smithy.api#documentation": "

(Discontinued) The prefix of the S3 bucket whose classification types you want to\n update.

" } }, "classificationTypeUpdate": { "target": "com.amazonaws.macie#ClassificationTypeUpdate", "traits": { - "smithy.api#documentation": "

The classification type that you want to update for the resource associated with Amazon\n Macie Classic.

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

(Discontinued) The classification type that you want to update for the resource\n associated with Amazon Macie Classic.

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

The S3 resources whose classification types you want to update. This data type is used\n as a request parameter in the UpdateS3Resources action.

" + "smithy.api#documentation": "

(Discontinued) The S3 resources whose classification types you want to update. This\n data type is used as a request parameter in the UpdateS3Resources action.

" } }, "com.amazonaws.macie#S3Resources": { @@ -748,7 +748,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the classification types for the specified S3 resources. If memberAccountId\n isn't specified, the action updates the classification types of the S3 resources associated\n with Amazon Macie Classic for the current Macie Classic administrator account. If memberAccountId is specified, the\n action updates the classification types of the S3 resources associated with Macie\n Classic for the specified member account.

" + "smithy.api#documentation": "

(Discontinued) Updates the classification types for the specified S3 resources. If\n memberAccountId isn't specified, the action updates the classification types of the S3\n resources associated with Amazon Macie Classic for the current Macie Classic administrator\n account. If memberAccountId is specified, the action updates the classification types of the\n S3 resources associated with Macie Classic for the specified member account.

" } }, "com.amazonaws.macie#UpdateS3ResourcesRequest": { @@ -757,13 +757,13 @@ "memberAccountId": { "target": "com.amazonaws.macie#AWSAccountId", "traits": { - "smithy.api#documentation": "

The AWS ID of the Amazon Macie Classic member account whose S3 resources'\n classification types you want to update.

" + "smithy.api#documentation": "

(Discontinued) The Amazon Web Services account ID of the Amazon Macie Classic member account whose S3\n resources' classification types you want to update.

" } }, "s3ResourcesUpdate": { "target": "com.amazonaws.macie#S3ResourcesClassificationUpdate", "traits": { - "smithy.api#documentation": "

The S3 resources whose classification types you want to update.

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

(Discontinued) The S3 resources whose classification types you want to\n update.

", "smithy.api#required": {} } } @@ -775,7 +775,7 @@ "failedS3Resources": { "target": "com.amazonaws.macie#FailedS3Resources", "traits": { - "smithy.api#documentation": "

The S3 resources whose classification types can't be updated. An error code and an\n error message are provided for each failed item.

" + "smithy.api#documentation": "

(Discontinued) The S3 resources whose classification types can't be updated. An error\n code and an error message are provided for each failed item.

" } } } diff --git a/aws/sdk/aws-models/mediaconvert.json b/aws/sdk/aws-models/mediaconvert.json index 8698fea9ff..1262af7ede 100644 --- a/aws/sdk/aws-models/mediaconvert.json +++ b/aws/sdk/aws-models/mediaconvert.json @@ -3518,7 +3518,7 @@ "TimedMetadata": { "target": "com.amazonaws.mediaconvert#CmfcTimedMetadata", "traits": { - "smithy.api#documentation": "Applies to CMAF outputs. Use this setting to specify whether the service inserts the ID3 timed metadata from the input in this output.", + "smithy.api#documentation": "To include ID3 metadata in this output: Set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH). Specify this ID3 metadata in Custom ID3 metadata inserter (timedMetadataInsertion). MediaConvert writes each instance of ID3 metadata in a separate Event Message (eMSG) box. To exclude this ID3 metadata: Set ID3 metadata to None (NONE) or leave blank.", "smithy.api#jsonName": "timedMetadata" } } @@ -3530,7 +3530,7 @@ "com.amazonaws.mediaconvert#CmfcTimedMetadata": { "type": "string", "traits": { - "smithy.api#documentation": "Applies to CMAF outputs. Use this setting to specify whether the service inserts the ID3 timed metadata from the input in this output.", + "smithy.api#documentation": "To include ID3 metadata in this output: Set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH). Specify this ID3 metadata in Custom ID3 metadata inserter (timedMetadataInsertion). MediaConvert writes each instance of ID3 metadata in a separate Event Message (eMSG) box. To exclude this ID3 metadata: Set ID3 metadata to None (NONE) or leave blank.", "smithy.api#enum": [ { "value": "PASSTHROUGH", @@ -6736,6 +6736,22 @@ ] } }, + "com.amazonaws.mediaconvert#EmbeddedTimecodeOverride": { + "type": "string", + "traits": { + "smithy.api#documentation": "Set Embedded timecode override (embeddedTimecodeOverride) to Use MDPM (USE_MDPM) when your AVCHD input contains timecode tag data in the Modified Digital Video Pack Metadata (MDPM). When you do, we recommend you also set Timecode source (inputTimecodeSource) to Embedded (EMBEDDED). Leave Embedded timecode override blank, or set to None (NONE), when your input does not contain MDPM timecode.", + "smithy.api#enum": [ + { + "value": "NONE", + "name": "NONE" + }, + { + "value": "USE_MDPM", + "name": "USE_MDPM" + } + ] + } + }, "com.amazonaws.mediaconvert#Endpoint": { "type": "structure", "members": { @@ -9282,6 +9298,22 @@ ] } }, + "com.amazonaws.mediaconvert#HlsCaptionSegmentLengthControl": { + "type": "string", + "traits": { + "smithy.api#documentation": "Set Caption segment length control (CaptionSegmentLengthControl) to Match video (MATCH_VIDEO) to create caption segments that align with the video segments from the first video output in this output group. For example, if the video segments are 2 seconds long, your WebVTT segments will also be 2 seconds long. Keep the default setting, Large segments (LARGE_SEGMENTS) to create caption segments that are 300 seconds long.", + "smithy.api#enum": [ + { + "value": "LARGE_SEGMENTS", + "name": "LARGE_SEGMENTS" + }, + { + "value": "MATCH_VIDEO", + "name": "MATCH_VIDEO" + } + ] + } + }, "com.amazonaws.mediaconvert#HlsClientCache": { "type": "string", "traits": { @@ -9464,6 +9496,13 @@ "smithy.api#jsonName": "captionLanguageSetting" } }, + "CaptionSegmentLengthControl": { + "target": "com.amazonaws.mediaconvert#HlsCaptionSegmentLengthControl", + "traits": { + "smithy.api#documentation": "Set Caption segment length control (CaptionSegmentLengthControl) to Match video (MATCH_VIDEO) to create caption segments that align with the video segments from the first video output in this output group. For example, if the video segments are 2 seconds long, your WebVTT segments will also be 2 seconds long. Keep the default setting, Large segments (LARGE_SEGMENTS) to create caption segments that are 300 seconds long.", + "smithy.api#jsonName": "captionSegmentLengthControl" + } + }, "ClientCache": { "target": "com.amazonaws.mediaconvert#HlsClientCache", "traits": { @@ -9614,14 +9653,14 @@ "TimedMetadataId3Frame": { "target": "com.amazonaws.mediaconvert#HlsTimedMetadataId3Frame", "traits": { - "smithy.api#documentation": "Indicates ID3 frame that has the timecode.", + "smithy.api#documentation": "Specify the type of the ID3 frame (timedMetadataId3Frame) to use for ID3 timestamps (timedMetadataId3Period) in your output. To include ID3 timestamps: Specify PRIV (PRIV) or TDRL (TDRL) and set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH). To exclude ID3 timestamps: Set ID3 timestamp frame type to None (NONE).", "smithy.api#jsonName": "timedMetadataId3Frame" } }, "TimedMetadataId3Period": { "target": "com.amazonaws.mediaconvert#__integerMinNegative2147483648Max2147483647", "traits": { - "smithy.api#documentation": "Timed Metadata interval in seconds.", + "smithy.api#documentation": "Specify the interval in seconds to write ID3 timestamps in your output. The first timestamp starts at the output timecode and date, and increases incrementally with each ID3 timestamp. To use the default interval of 10 seconds: Leave blank. To include this metadata in your output: Set ID3 timestamp frame type (timedMetadataId3Frame) to PRIV (PRIV) or TDRL (TDRL), and set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH).", "smithy.api#jsonName": "timedMetadataId3Period" } }, @@ -10008,7 +10047,7 @@ "com.amazonaws.mediaconvert#HlsTimedMetadataId3Frame": { "type": "string", "traits": { - "smithy.api#documentation": "Indicates ID3 frame that has the timecode.", + "smithy.api#documentation": "Specify the type of the ID3 frame (timedMetadataId3Frame) to use for ID3 timestamps (timedMetadataId3Period) in your output. To include ID3 timestamps: Specify PRIV (PRIV) or TDRL (TDRL) and set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH). To exclude ID3 timestamps: Set ID3 timestamp frame type to None (NONE).", "smithy.api#enum": [ { "value": "NONE", @@ -10060,7 +10099,7 @@ "Id3": { "target": "com.amazonaws.mediaconvert#__stringPatternAZaZ0902", "traits": { - "smithy.api#documentation": "Use ID3 tag (Id3) to provide a tag value in base64-encode format.", + "smithy.api#documentation": "Use ID3 tag (Id3) to provide a fully formed ID3 tag in base64-encode format.", "smithy.api#jsonName": "id3" } }, @@ -10094,7 +10133,7 @@ "com.amazonaws.mediaconvert#ImscAccessibilitySubs": { "type": "string", "traits": { - "smithy.api#documentation": "Specify whether to flag this caption track as accessibility in your HLS/CMAF parent manifest. When you choose ENABLED, MediaConvert includes the parameters CHARACTERISTICS=\"public.accessibility.describes-spoken-dialog,public.accessibility.describes-music-and-sound\" and AUTOSELECT=\"YES\" in the EXT-X-MEDIA entry for this track. When you keep the default choice, DISABLED, MediaConvert leaves this parameter out.", + "smithy.api#documentation": "Set Accessibility subtitles (Accessibility) to Enabled (ENABLED) if the ISMC or WebVTT captions track is intended to provide accessibility for people who are deaf or hard of hearing. When you enable this feature, MediaConvert adds the following attributes under EXT-X-MEDIA in the HLS or CMAF manifest for this track: CHARACTERISTICS=\"public.accessibility.describes-spoken-dialog,public.accessibility.describes-music-and-sound\" and AUTOSELECT=\"YES\". Keep the default value, Disabled (DISABLED), if the captions track is not intended to provide such accessibility. MediaConvert will not add the above attributes.", "smithy.api#enum": [ { "value": "DISABLED", @@ -10113,7 +10152,7 @@ "Accessibility": { "target": "com.amazonaws.mediaconvert#ImscAccessibilitySubs", "traits": { - "smithy.api#documentation": "Specify whether to flag this caption track as accessibility in your HLS/CMAF parent manifest. When you choose ENABLED, MediaConvert includes the parameters CHARACTERISTICS=\"public.accessibility.describes-spoken-dialog,public.accessibility.describes-music-and-sound\" and AUTOSELECT=\"YES\" in the EXT-X-MEDIA entry for this track. When you keep the default choice, DISABLED, MediaConvert leaves this parameter out.", + "smithy.api#documentation": "Set Accessibility subtitles (Accessibility) to Enabled (ENABLED) if the ISMC or WebVTT captions track is intended to provide accessibility for people who are deaf or hard of hearing. When you enable this feature, MediaConvert adds the following attributes under EXT-X-MEDIA in the HLS or CMAF manifest for this track: CHARACTERISTICS=\"public.accessibility.describes-spoken-dialog,public.accessibility.describes-music-and-sound\" and AUTOSELECT=\"YES\". Keep the default value, Disabled (DISABLED), if the captions track is not intended to provide such accessibility. MediaConvert will not add the above attributes.", "smithy.api#jsonName": "accessibility" } }, @@ -11071,7 +11110,7 @@ "TimedMetadataInsertion": { "target": "com.amazonaws.mediaconvert#TimedMetadataInsertion", "traits": { - "smithy.api#documentation": "Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in any HLS outputs. To include timed metadata, you must enable it here, enable it in each output container, and specify tags and timecodes in ID3 insertion (Id3Insertion) objects.", + "smithy.api#documentation": "Insert user-defined custom ID3 metadata (id3) at timecodes (timecode) that you specify. In each output that you want to include this metadata, you must set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH).", "smithy.api#jsonName": "timedMetadataInsertion" } } @@ -11312,7 +11351,7 @@ "TimedMetadataInsertion": { "target": "com.amazonaws.mediaconvert#TimedMetadataInsertion", "traits": { - "smithy.api#documentation": "Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in any HLS outputs. To include timed metadata, you must enable it here, enable it in each output container, and specify tags and timecodes in ID3 insertion (Id3Insertion) objects.", + "smithy.api#documentation": "Insert user-defined custom ID3 metadata (id3) at timecodes (timecode) that you specify. In each output that you want to include this metadata, you must set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH).", "smithy.api#jsonName": "timedMetadataInsertion" } } @@ -13379,14 +13418,14 @@ "TimedMetadata": { "target": "com.amazonaws.mediaconvert#TimedMetadata", "traits": { - "smithy.api#documentation": "Applies to HLS outputs. Use this setting to specify whether the service inserts the ID3 timed metadata from the input in this output.", + "smithy.api#documentation": "Set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH) to include ID3 metadata in this output. This includes ID3 metadata from the following features: ID3 timestamp period (timedMetadataId3Period), and Custom ID3 metadata inserter (timedMetadataInsertion). To exclude this ID3 metadata in this output: set ID3 metadata to None (NONE) or leave blank.", "smithy.api#jsonName": "timedMetadata" } }, "TimedMetadataPid": { "target": "com.amazonaws.mediaconvert#__integerMin32Max8182", "traits": { - "smithy.api#documentation": "Packet Identifier (PID) of the timed metadata stream in the transport stream.", + "smithy.api#documentation": "Packet Identifier (PID) of the ID3 metadata stream in the transport stream.", "smithy.api#jsonName": "timedMetadataPid" } }, @@ -14070,7 +14109,7 @@ "TimedMetadata": { "target": "com.amazonaws.mediaconvert#MpdTimedMetadata", "traits": { - "smithy.api#documentation": "Applies to DASH outputs. Use this setting to specify whether the service inserts the ID3 timed metadata from the input in this output.", + "smithy.api#documentation": "To include ID3 metadata in this output: Set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH). Specify this ID3 metadata in Custom ID3 metadata inserter (timedMetadataInsertion). MediaConvert writes each instance of ID3 metadata in a separate Event Message (eMSG) box. To exclude this ID3 metadata: Set ID3 metadata to None (NONE) or leave blank.", "smithy.api#jsonName": "timedMetadata" } } @@ -14082,7 +14121,7 @@ "com.amazonaws.mediaconvert#MpdTimedMetadata": { "type": "string", "traits": { - "smithy.api#documentation": "Applies to DASH outputs. Use this setting to specify whether the service inserts the ID3 timed metadata from the input in this output.", + "smithy.api#documentation": "To include ID3 metadata in this output: Set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH). Specify this ID3 metadata in Custom ID3 metadata inserter (timedMetadataInsertion). MediaConvert writes each instance of ID3 metadata in a separate Event Message (eMSG) box. To exclude this ID3 metadata: Set ID3 metadata to None (NONE) or leave blank.", "smithy.api#enum": [ { "value": "PASSTHROUGH", @@ -15137,7 +15176,7 @@ "com.amazonaws.mediaconvert#NoiseFilterPostTemporalSharpening": { "type": "string", "traits": { - "smithy.api#documentation": "When you set Noise reducer (noiseReducer) to Temporal (TEMPORAL), the sharpness of your output is reduced. You can optionally use Post temporal sharpening (PostTemporalSharpening) to apply sharpening to the edges of your output. The default behavior, Auto (AUTO), allows the transcoder to determine whether to apply sharpening, depending on your input type and quality. When you set Post temporal sharpening to Enabled (ENABLED), specify how much sharpening is applied using Post temporal sharpening strength (PostTemporalSharpeningStrength). Set Post temporal sharpening to Disabled (DISABLED) to not apply sharpening.", + "smithy.api#documentation": "When you set Noise reducer (noiseReducer) to Temporal (TEMPORAL), the bandwidth and sharpness of your output is reduced. You can optionally use Post temporal sharpening (postTemporalSharpening) to apply sharpening to the edges of your output. Note that Post temporal sharpening will also make the bandwidth reduction from the Noise reducer smaller. The default behavior, Auto (AUTO), allows the transcoder to determine whether to apply sharpening, depending on your input type and quality. When you set Post temporal sharpening to Enabled (ENABLED), specify how much sharpening is applied using Post temporal sharpening strength (postTemporalSharpeningStrength). Set Post temporal sharpening to Disabled (DISABLED) to not apply sharpening.", "smithy.api#enum": [ { "value": "DISABLED", @@ -15157,7 +15196,7 @@ "com.amazonaws.mediaconvert#NoiseFilterPostTemporalSharpeningStrength": { "type": "string", "traits": { - "smithy.api#documentation": "Use Post temporal sharpening strength (PostTemporalSharpeningStrength) to define the amount of sharpening the transcoder applies to your output. Set Post temporal sharpening strength to Low (LOW), or leave blank, to apply a low amount of sharpening. Set Post temporal sharpening strength to Medium (MEDIUM) to apply medium amount of sharpening. Set Post temporal sharpening strength to High (HIGH) to apply a high amount of sharpening.", + "smithy.api#documentation": "Use Post temporal sharpening strength (postTemporalSharpeningStrength) to define the amount of sharpening the transcoder applies to your output. Set Post temporal sharpening strength to Low (LOW), Medium (MEDIUM), or High (HIGH) to indicate the amount of sharpening.", "smithy.api#enum": [ { "value": "LOW", @@ -15307,14 +15346,14 @@ "PostTemporalSharpening": { "target": "com.amazonaws.mediaconvert#NoiseFilterPostTemporalSharpening", "traits": { - "smithy.api#documentation": "When you set Noise reducer (noiseReducer) to Temporal (TEMPORAL), the sharpness of your output is reduced. You can optionally use Post temporal sharpening (PostTemporalSharpening) to apply sharpening to the edges of your output. The default behavior, Auto (AUTO), allows the transcoder to determine whether to apply sharpening, depending on your input type and quality. When you set Post temporal sharpening to Enabled (ENABLED), specify how much sharpening is applied using Post temporal sharpening strength (PostTemporalSharpeningStrength). Set Post temporal sharpening to Disabled (DISABLED) to not apply sharpening.", + "smithy.api#documentation": "When you set Noise reducer (noiseReducer) to Temporal (TEMPORAL), the bandwidth and sharpness of your output is reduced. You can optionally use Post temporal sharpening (postTemporalSharpening) to apply sharpening to the edges of your output. Note that Post temporal sharpening will also make the bandwidth reduction from the Noise reducer smaller. The default behavior, Auto (AUTO), allows the transcoder to determine whether to apply sharpening, depending on your input type and quality. When you set Post temporal sharpening to Enabled (ENABLED), specify how much sharpening is applied using Post temporal sharpening strength (postTemporalSharpeningStrength). Set Post temporal sharpening to Disabled (DISABLED) to not apply sharpening.", "smithy.api#jsonName": "postTemporalSharpening" } }, "PostTemporalSharpeningStrength": { "target": "com.amazonaws.mediaconvert#NoiseFilterPostTemporalSharpeningStrength", "traits": { - "smithy.api#documentation": "Use Post temporal sharpening strength (PostTemporalSharpeningStrength) to define the amount of sharpening the transcoder applies to your output. Set Post temporal sharpening strength to Low (LOW), or leave blank, to apply a low amount of sharpening. Set Post temporal sharpening strength to Medium (MEDIUM) to apply medium amount of sharpening. Set Post temporal sharpening strength to High (HIGH) to apply a high amount of sharpening.", + "smithy.api#documentation": "Use Post temporal sharpening strength (postTemporalSharpeningStrength) to define the amount of sharpening the transcoder applies to your output. Set Post temporal sharpening strength to Low (LOW), Medium (MEDIUM), or High (HIGH) to indicate the amount of sharpening.", "smithy.api#jsonName": "postTemporalSharpeningStrength" } }, @@ -17238,7 +17277,7 @@ "com.amazonaws.mediaconvert#TimedMetadata": { "type": "string", "traits": { - "smithy.api#documentation": "Applies to HLS outputs. Use this setting to specify whether the service inserts the ID3 timed metadata from the input in this output.", + "smithy.api#documentation": "Set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH) to include ID3 metadata in this output. This includes ID3 metadata from the following features: ID3 timestamp period (timedMetadataId3Period), and Custom ID3 metadata inserter (timedMetadataInsertion). To exclude this ID3 metadata in this output: set ID3 metadata to None (NONE) or leave blank.", "smithy.api#enum": [ { "value": "PASSTHROUGH", @@ -17263,7 +17302,7 @@ } }, "traits": { - "smithy.api#documentation": "Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in any HLS outputs. To include timed metadata, you must enable it here, enable it in each output container, and specify tags and timecodes in ID3 insertion (Id3Insertion) objects." + "smithy.api#documentation": "Insert user-defined custom ID3 metadata (id3) at timecodes (timecode) that you specify. In each output that you want to include this metadata, you must set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH)." } }, "com.amazonaws.mediaconvert#Timing": { @@ -18291,6 +18330,13 @@ "smithy.api#jsonName": "colorSpaceUsage" } }, + "EmbeddedTimecodeOverride": { + "target": "com.amazonaws.mediaconvert#EmbeddedTimecodeOverride", + "traits": { + "smithy.api#documentation": "Set Embedded timecode override (embeddedTimecodeOverride) to Use MDPM (USE_MDPM) when your AVCHD input contains timecode tag data in the Modified Digital Video Pack Metadata (MDPM). When you do, we recommend you also set Timecode source (inputTimecodeSource) to Embedded (EMBEDDED). Leave Embedded timecode override blank, or set to None (NONE), when your input does not contain MDPM timecode.", + "smithy.api#jsonName": "embeddedTimecodeOverride" + } + }, "Hdr10Metadata": { "target": "com.amazonaws.mediaconvert#Hdr10Metadata", "traits": { @@ -18817,7 +18863,7 @@ "com.amazonaws.mediaconvert#WebvttAccessibilitySubs": { "type": "string", "traits": { - "smithy.api#documentation": "Specify whether to flag this caption track as accessibility in your HLS/CMAF parent manifest. When you choose ENABLED, MediaConvert includes the parameters CHARACTERISTICS=\"public.accessibility.describes-spoken-dialog,public.accessibility.describes-music-and-sound\" and AUTOSELECT=\"YES\" in the EXT-X-MEDIA entry for this track. When you keep the default choice, DISABLED, MediaConvert leaves this parameter out.", + "smithy.api#documentation": "Set Accessibility subtitles (Accessibility) to Enabled (ENABLED) if the ISMC or WebVTT captions track is intended to provide accessibility for people who are deaf or hard of hearing. When you enable this feature, MediaConvert adds the following attributes under EXT-X-MEDIA in the HLS or CMAF manifest for this track: CHARACTERISTICS=\"public.accessibility.describes-spoken-dialog,public.accessibility.describes-music-and-sound\" and AUTOSELECT=\"YES\". Keep the default value, Disabled (DISABLED), if the captions track is not intended to provide such accessibility. MediaConvert will not add the above attributes.", "smithy.api#enum": [ { "value": "DISABLED", @@ -18836,7 +18882,7 @@ "Accessibility": { "target": "com.amazonaws.mediaconvert#WebvttAccessibilitySubs", "traits": { - "smithy.api#documentation": "Specify whether to flag this caption track as accessibility in your HLS/CMAF parent manifest. When you choose ENABLED, MediaConvert includes the parameters CHARACTERISTICS=\"public.accessibility.describes-spoken-dialog,public.accessibility.describes-music-and-sound\" and AUTOSELECT=\"YES\" in the EXT-X-MEDIA entry for this track. When you keep the default choice, DISABLED, MediaConvert leaves this parameter out.", + "smithy.api#documentation": "Set Accessibility subtitles (Accessibility) to Enabled (ENABLED) if the ISMC or WebVTT captions track is intended to provide accessibility for people who are deaf or hard of hearing. When you enable this feature, MediaConvert adds the following attributes under EXT-X-MEDIA in the HLS or CMAF manifest for this track: CHARACTERISTICS=\"public.accessibility.describes-spoken-dialog,public.accessibility.describes-music-and-sound\" and AUTOSELECT=\"YES\". Keep the default value, Disabled (DISABLED), if the captions track is not intended to provide such accessibility. MediaConvert will not add the above attributes.", "smithy.api#jsonName": "accessibility" } }, diff --git a/aws/sdk/aws-models/mediapackage.json b/aws/sdk/aws-models/mediapackage.json index aeba6134cc..47e766e66f 100644 --- a/aws/sdk/aws-models/mediapackage.json +++ b/aws/sdk/aws-models/mediapackage.json @@ -2339,6 +2339,21 @@ }, "com.amazonaws.mediapackage#MediaPackage": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "MediaPackage", + "arnNamespace": "mediapackage", + "cloudFormationName": "MediaPackage", + "cloudTrailEventSource": "mediapackage.amazonaws.com", + "endpointPrefix": "mediapackage" + }, + "aws.auth#sigv4": { + "name": "mediapackage" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "AWS Elemental MediaPackage", + "smithy.api#title": "AWS Elemental MediaPackage" + }, "version": "2017-10-12", "operations": [ { @@ -2398,22 +2413,7 @@ { "target": "com.amazonaws.mediapackage#UpdateOriginEndpoint" } - ], - "traits": { - "aws.api#service": { - "sdkId": "MediaPackage", - "arnNamespace": "mediapackage", - "cloudFormationName": "MediaPackage", - "cloudTrailEventSource": "mediapackage.amazonaws.com", - "endpointPrefix": "mediapackage" - }, - "aws.auth#sigv4": { - "name": "mediapackage" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "AWS Elemental MediaPackage", - "smithy.api#title": "AWS Elemental MediaPackage" - } + ] }, "com.amazonaws.mediapackage#MssEncryption": { "type": "structure", @@ -2661,6 +2661,10 @@ { "value": "HBBTV_1_5", "name": "HBBTV_1_5" + }, + { + "value": "HYBRIDCAST", + "name": "HYBRIDCAST" } ] } diff --git a/aws/sdk/aws-models/mgn.json b/aws/sdk/aws-models/mgn.json index 5043d8a4eb..8e91c899b4 100644 --- a/aws/sdk/aws-models/mgn.json +++ b/aws/sdk/aws-models/mgn.json @@ -108,6 +108,21 @@ } ] }, + "com.amazonaws.mgn#BootMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "LEGACY_BIOS", + "name": "LEGACY_BIOS" + }, + { + "value": "UEFI", + "name": "UEFI" + } + ] + } + }, "com.amazonaws.mgn#BoundedString": { "type": "string", "traits": { @@ -233,13 +248,13 @@ "resourceId": { "target": "com.amazonaws.mgn#LargeBoundedString", "traits": { - "smithy.api#documentation": "

A conflict occured when prompting for the Resource ID.

" + "smithy.api#documentation": "

A conflict occurred when prompting for the Resource ID.

" } }, "resourceType": { "target": "com.amazonaws.mgn#LargeBoundedString", "traits": { - "smithy.api#documentation": "

A conflict occured when prompting for resource type.

" + "smithy.api#documentation": "

A conflict occurred when prompting for resource type.

" } } }, @@ -309,7 +324,7 @@ "replicationServersSecurityGroupsIDs": { "target": "com.amazonaws.mgn#ReplicationServersSecurityGroupsIDs", "traits": { - "smithy.api#documentation": "

Request to configure the Replication Server Secuirity group ID during Replication Settings template creation.

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

Request to configure the Replication Server Security group ID during Replication Settings template creation.

", "smithy.api#required": {} } }, @@ -330,21 +345,21 @@ "defaultLargeStagingDiskType": { "target": "com.amazonaws.mgn#ReplicationConfigurationDefaultLargeStagingDiskType", "traits": { - "smithy.api#documentation": "

Request to configure the Staging Disk EBS volume type to \"gp2\" during Replication Settings template creation.

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

Request to configure the default large staging disk EBS volume type during Replication Settings template creation.

", "smithy.api#required": {} } }, "ebsEncryption": { "target": "com.amazonaws.mgn#ReplicationConfigurationEbsEncryption", "traits": { - "smithy.api#documentation": "

Request to configure EBS enryption during Replication Settings template creation.

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

Request to configure EBS encryption during Replication Settings template creation.

", "smithy.api#required": {} } }, "ebsEncryptionKeyArn": { "target": "com.amazonaws.mgn#ARN", "traits": { - "smithy.api#documentation": "

Request to configure an EBS enryption key during Replication Settings template creation.

" + "smithy.api#documentation": "

Request to configure an EBS encryption key during Replication Settings template creation.

" } }, "bandwidthThrottling": { @@ -371,7 +386,7 @@ "stagingAreaTags": { "target": "com.amazonaws.mgn#TagsMap", "traits": { - "smithy.api#documentation": "

Request to configure Staiging Area tags during Replication Settings template creation.

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

Request to configure Staging Area tags during Replication Settings template creation.

", "smithy.api#required": {} } }, @@ -480,7 +495,7 @@ "lagDuration": { "target": "com.amazonaws.mgn#ISO8601DatetimeString", "traits": { - "smithy.api#documentation": "

Request to query data replication lag durating.

" + "smithy.api#documentation": "

Request to query data replication lag duration.

" } }, "etaDateTime": { @@ -617,7 +632,7 @@ } }, "traits": { - "smithy.api#documentation": "

Data replication intiation step.

" + "smithy.api#documentation": "

Data replication initiation step.

" } }, "com.amazonaws.mgn#DataReplicationInitiationStepName": { @@ -899,6 +914,9 @@ "input": { "target": "com.amazonaws.mgn#DeleteVcenterClientRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.mgn#ResourceNotFoundException" @@ -911,7 +929,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a single vCenter client by ID.

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

Deletes a given vCenter client by ID.

", "smithy.api#http": { "method": "POST", "uri": "/DeleteVcenterClient", @@ -949,7 +967,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves detailed Job log with paging.

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

Retrieves detailed job log items with paging.

", "smithy.api#http": { "method": "POST", "uri": "/DescribeJobLogItems", @@ -1022,7 +1040,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of Jobs. Use the JobsID and fromDate and toData filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are normaly created by the StartTest, StartCutover, and TerminateTargetInstances APIs. Jobs are also created by DiagnosticLaunch and TerminateDiagnosticInstances, which are APIs available only to *Support* and only used in response to relevant support tickets.

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

Returns a list of Jobs. Use the JobsID and fromDate and toData filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are normally created by the StartTest, StartCutover, and TerminateTargetInstances APIs. Jobs are also created by DiagnosticLaunch and TerminateDiagnosticInstances, which are APIs available only to *Support* and only used in response to relevant support tickets.

", "smithy.api#http": { "method": "POST", "uri": "/DescribeJobs", @@ -1050,13 +1068,13 @@ "maxResults": { "target": "com.amazonaws.mgn#StrictlyPositiveInteger", "traits": { - "smithy.api#documentation": "

Request to describe Job log by max results.

" + "smithy.api#documentation": "

Request to describe job log items by max results.

" } }, "nextToken": { "target": "com.amazonaws.mgn#PaginationToken", "traits": { - "smithy.api#documentation": "

Request to describe Job logby next token.

" + "smithy.api#documentation": "

Request to describe job log items by next token.

" } } } @@ -1079,7 +1097,7 @@ "toDate": { "target": "com.amazonaws.mgn#ISO8601DatetimeString", "traits": { - "smithy.api#documentation": "

Request to describe Job log by last date.

" + "smithy.api#documentation": "

Request to describe job log items by last date.

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

Lists all vCenter clients.

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

Returns a list of the installed vCenter clients.

", "smithy.api#http": { "method": "GET", "uri": "/DescribeVcenterClients", @@ -1400,7 +1418,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disconnects specific Source Servers from Application Migration Service. Data replication is stopped immediately. All AWS resources created by Application Migration Service for enabling the replication of these source servers will be terminated / deleted within 90 minutes. Launched Test or Cutover instances will NOT be terminated. If the agent on the source server has not been prevented from communciating with the Application Migration Service service, then it will receive a command to uninstall itself (within approximately 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; The totalStorageBytes property for each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDurationwill be nullified.

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

Disconnects specific Source Servers from Application Migration Service. Data replication is stopped immediately. All AWS resources created by Application Migration Service for enabling the replication of these source servers will be terminated / deleted within 90 minutes. Launched Test or Cutover instances will NOT be terminated. If the agent on the source server has not been prevented from communicating with the Application Migration Service service, then it will receive a command to uninstall itself (within approximately 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; The totalStorageBytes property for each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.

", "smithy.api#http": { "method": "POST", "uri": "/DisconnectFromService", @@ -1494,7 +1512,7 @@ } ], "traits": { - "smithy.api#documentation": "

Finalizes the cutover immediately for specific Source Servers. All AWS resources created by Application Migration Service for enabling the replication of these source servers will be terminated / deleted within 90 minutes. Launched Test or Cutover instances will NOT be terminated. The AWS Replication Agent will receive a command to uninstall itself (within 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be to DISCONNECTED; The SourceServer.lifeCycle.state will be changed to CUTOVER; The totalStorageBytes property fo each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDurationwill be nullified.

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

Finalizes the cutover immediately for specific Source Servers. All AWS resources created by Application Migration Service for enabling the replication of these source servers will be terminated / deleted within 90 minutes. Launched Test or Cutover instances will NOT be terminated. The AWS Replication Agent will receive a command to uninstall itself (within 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be changed to DISCONNECTED; The SourceServer.lifeCycle.state will be changed to CUTOVER; The totalStorageBytes property fo each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.

", "smithy.api#http": { "method": "POST", "uri": "/FinalizeCutover", @@ -1508,7 +1526,7 @@ "sourceServerID": { "target": "com.amazonaws.mgn#SourceServerID", "traits": { - "smithy.api#documentation": "

Request to finalize Cutover by Soure Server ID.

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

Request to finalize Cutover by Source Server ID.

", "smithy.api#required": {} } } @@ -1607,7 +1625,7 @@ "sourceServerID": { "target": "com.amazonaws.mgn#SourceServerID", "traits": { - "smithy.api#documentation": "

Request to get Replication Configuaration by Source Server ID.

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

Request to get Replication Configuration by Source Server ID.

", "smithy.api#required": {} } } @@ -1801,7 +1819,7 @@ "tags": { "target": "com.amazonaws.mgn#TagsMap", "traits": { - "smithy.api#documentation": "

Tags associated with spcific Job.

" + "smithy.api#documentation": "

Tags associated with specific Job.

" } } }, @@ -2036,31 +2054,31 @@ "sourceServerID": { "target": "com.amazonaws.mgn#SourceServerID", "traits": { - "smithy.api#documentation": "

Configure launch configuration Source Server ID.

" + "smithy.api#documentation": "

Launch configuration Source Server ID.

" } }, "name": { "target": "com.amazonaws.mgn#SmallBoundedString", "traits": { - "smithy.api#documentation": "

Configure launch configuration name.

" + "smithy.api#documentation": "

Launch configuration name.

" } }, "ec2LaunchTemplateID": { "target": "com.amazonaws.mgn#BoundedString", "traits": { - "smithy.api#documentation": "

Configure EC2 lauch configuration template ID.

" + "smithy.api#documentation": "

Launch configuration EC2 Launch template ID.

" } }, "launchDisposition": { "target": "com.amazonaws.mgn#LaunchDisposition", "traits": { - "smithy.api#documentation": "

Configure launch dispostion for launch configuration.

" + "smithy.api#documentation": "

Launch disposition for launch configuration.

" } }, "targetInstanceTypeRightSizingMethod": { "target": "com.amazonaws.mgn#TargetInstanceTypeRightSizingMethod", "traits": { - "smithy.api#documentation": "

Configure launch configuration Target instance type right sizing method.

" + "smithy.api#documentation": "

Launch configuration Target instance type right sizing method.

" } }, "copyPrivateIp": { @@ -2078,7 +2096,13 @@ "licensing": { "target": "com.amazonaws.mgn#Licensing", "traits": { - "smithy.api#documentation": "

Configure launch configuration OS licensing.

" + "smithy.api#documentation": "

Launch configuration OS licensing.

" + } + }, + "bootMode": { + "target": "com.amazonaws.mgn#BootMode", + "traits": { + "smithy.api#documentation": "

Launch configuration boot mode.

" } } } @@ -2131,24 +2155,24 @@ "ec2InstanceID": { "target": "com.amazonaws.mgn#EC2InstanceID", "traits": { - "smithy.api#documentation": "

Configure launced instance EC2 ID.

" + "smithy.api#documentation": "

Launched instance EC2 ID.

" } }, "jobID": { "target": "com.amazonaws.mgn#JobID", "traits": { - "smithy.api#documentation": "

Configure launced instance Job ID.

" + "smithy.api#documentation": "

Launched instance Job ID.

" } }, "firstBoot": { "target": "com.amazonaws.mgn#FirstBoot", "traits": { - "smithy.api#documentation": "

Configure launced instance first boot.

" + "smithy.api#documentation": "

Launched instance first boot.

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

Configure launced instance.

" + "smithy.api#documentation": "

Launched instance.

" } }, "com.amazonaws.mgn#Licensing": { @@ -2307,7 +2331,7 @@ "finalized": { "target": "com.amazonaws.mgn#LifeCycleLastTestFinalized", "traits": { - "smithy.api#documentation": "

Lifecycle last Test finlized.

" + "smithy.api#documentation": "

Lifecycle last Test finalized.

" } } }, @@ -2326,7 +2350,7 @@ } }, "traits": { - "smithy.api#documentation": "

Lifecycle last Test finlized.

" + "smithy.api#documentation": "

Lifecycle last Test finalized.

" } }, "com.amazonaws.mgn#LifeCycleLastTestInitiated": { @@ -2497,7 +2521,7 @@ } ], "traits": { - "smithy.api#documentation": "

Archives specific Source Servers by setting the SourceServer.isArchived property to true for specified SourceServers by ID. This command only works for SourceServers with a lifecycle.state which equals DISCONNECTED or CUTOVER.

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

Archives specific Source Servers by setting the SourceServer.isArchived property to true for specified SourceServers by ID. This command only works for SourceServers with a lifecycle. state which equals DISCONNECTED or CUTOVER.

", "smithy.api#http": { "method": "POST", "uri": "/MarkAsArchived", @@ -2733,6 +2757,10 @@ { "value": "ST1", "name": "ST1" + }, + { + "value": "GP3", + "name": "GP3" } ] } @@ -2778,6 +2806,12 @@ "traits": { "smithy.api#documentation": "

Replication Configuration replicated disk IOPs.

" } + }, + "throughput": { + "target": "com.amazonaws.mgn#PositiveInteger", + "traits": { + "smithy.api#documentation": "

Replication Configuration replicated disk throughput.

" + } } }, "traits": { @@ -2811,6 +2845,14 @@ { "value": "STANDARD", "name": "STANDARD" + }, + { + "value": "GP3", + "name": "GP3" + }, + { + "value": "IO2", + "name": "IO2" } ] } @@ -2833,7 +2875,7 @@ "replicationConfigurationTemplateID": { "target": "com.amazonaws.mgn#ReplicationConfigurationTemplateID", "traits": { - "smithy.api#documentation": "

Replication Configuration template template ID.

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

Replication Configuration template ID.

", "smithy.api#required": {} } }, @@ -2876,7 +2918,7 @@ "defaultLargeStagingDiskType": { "target": "com.amazonaws.mgn#ReplicationConfigurationDefaultLargeStagingDiskType", "traits": { - "smithy.api#documentation": "

Replication Configuration template use dedault large Staging Disk type.

" + "smithy.api#documentation": "

Replication Configuration template use default large Staging Disk type.

" } }, "ebsEncryption": { @@ -2894,7 +2936,7 @@ "bandwidthThrottling": { "target": "com.amazonaws.mgn#PositiveInteger", "traits": { - "smithy.api#documentation": "

Replication Configuration template bandwidth throtting.

" + "smithy.api#documentation": "

Replication Configuration template bandwidth throttling.

" } }, "dataPlaneRouting": { @@ -3108,7 +3150,7 @@ "resourceId": { "target": "com.amazonaws.mgn#LargeBoundedString", "traits": { - "smithy.api#documentation": "

Exceeded the service quota resource Id.

" + "smithy.api#documentation": "

Exceeded the service quota resource ID.

" } }, "resourceType": { @@ -3452,7 +3494,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts replication on source server by ID.

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

Starts replication for SNAPSHOT_SHIPPING agents.

", "smithy.api#http": { "method": "POST", "uri": "/StartReplication", @@ -3492,7 +3534,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lauches a Test Instance for specific Source Servers. This command starts a LAUNCH job whose initiatedBy property is StartTest and changes the SourceServer.lifeCycle.state property to TESTING.

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

Launches a Test Instance for specific Source Servers. This command starts a LAUNCH job whose initiatedBy property is StartTest and changes the SourceServer.lifeCycle.state property to TESTING.

", "smithy.api#http": { "method": "POST", "uri": "/StartTest", @@ -3582,6 +3624,9 @@ "input": { "target": "com.amazonaws.mgn#TagResourceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.mgn#AccessDeniedException" @@ -3780,7 +3825,7 @@ } }, "traits": { - "smithy.api#documentation": "

Unitialized account exception.

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

Uninitialized account exception.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -3790,6 +3835,9 @@ "input": { "target": "com.amazonaws.mgn#UntagResourceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.mgn#AccessDeniedException" @@ -3915,6 +3963,12 @@ "traits": { "smithy.api#documentation": "

Update Launch configuration licensing request.

" } + }, + "bootMode": { + "target": "com.amazonaws.mgn#BootMode", + "traits": { + "smithy.api#documentation": "

Update Launch configuration boot mode request.

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

Updates source server Replication Type by ID.

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

Allows you to change between the AGENT_BASED replication type and the SNAPSHOT_SHIPPING replication type.

", "smithy.api#http": { "method": "POST", "uri": "/UpdateSourceServerReplicationType", diff --git a/aws/sdk/aws-models/migration-hub-refactor-spaces.json b/aws/sdk/aws-models/migration-hub-refactor-spaces.json index 1798283eb6..5a7bb3572d 100644 --- a/aws/sdk/aws-models/migration-hub-refactor-spaces.json +++ b/aws/sdk/aws-models/migration-hub-refactor-spaces.json @@ -109,7 +109,7 @@ "NlbName": { "target": "com.amazonaws.migrationhubrefactorspaces#NlbName", "traits": { - "smithy.api#documentation": "

The name of the Network Load Balancer that is configured by the API Gateway proxy.

" + "smithy.api#documentation": "

The name of the Network Load Balancer that is configured by the API Gateway proxy.\n

" } }, "EndpointType": { @@ -179,7 +179,7 @@ "NlbName": { "target": "com.amazonaws.migrationhubrefactorspaces#NlbName", "traits": { - "smithy.api#documentation": "

The name of the Network Load Balancer that is configured by the API Gateway proxy.

" + "smithy.api#documentation": "

The name of the Network Load Balancer that is configured by the API Gateway proxy.\n

" } }, "EndpointType": { @@ -264,13 +264,13 @@ "Arn": { "target": "com.amazonaws.migrationhubrefactorspaces#ResourceArn", "traits": { - "smithy.api#documentation": "

he Amazon Resource Name (ARN) of the application.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the application.

" } }, "OwnerAccountId": { "target": "com.amazonaws.migrationhubrefactorspaces#AccountId", "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID of the application owner.

" + "smithy.api#documentation": "

The Amazon Web Services account ID of the application owner (which is always the same as\n the environment owner account ID).

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

Creates an Amazon Web Services Migration Hub Refactor Spaces application. The account that owns the environment also owns the\n applications created inside the environment, regardless of the account that creates the\n application. Refactor Spaces provisions the Amazon API Gateway and Network Load Balancer for\n the application proxy inside your account.

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

Creates an Amazon Web Services Migration Hub Refactor Spaces application. The account that owns the environment also owns the\n applications created inside the environment, regardless of the account that creates the\n application. Refactor Spaces provisions an Amazon API Gateway, API Gateway VPC link, and\n Network Load Balancer for the application proxy inside your account.

", "smithy.api#http": { "method": "POST", "uri": "/environments/{EnvironmentIdentifier}/applications", @@ -515,7 +515,7 @@ "OwnerAccountId": { "target": "com.amazonaws.migrationhubrefactorspaces#AccountId", "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID of the application owner.

" + "smithy.api#documentation": "

The Amazon Web Services account ID of the application owner (which is always the same as\n the environment owner account ID).

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

Creates an Amazon Web Services Migration Hub Refactor Spaces environment. The caller owns the environment resource, and they\n are referred to as the environment owner. The environment owner has\n cross-account visibility and control of Refactor Spaces resources that are added to the environment\n by other accounts that the environment is shared with. When creating an environment, Refactor Spaces\n provisions a transit gateway in your account.

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

Creates an Amazon Web Services Migration Hub Refactor Spaces environment. The caller owns the environment resource, and all\n Refactor Spaces applications, services, and routes created within the environment. They are referred\n to as the environment owner. The environment owner has cross-account\n visibility and control of Refactor Spaces resources that are added to the environment by other\n accounts that the environment is shared with. When creating an environment, Refactor Spaces\n provisions a transit gateway in your account.

", "smithy.api#http": { "method": "POST", "uri": "/environments", @@ -755,7 +755,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an Amazon Web Services Migration Hub Refactor Spaces route. The account owner of the service resource is always the\n environment owner, regardless of which account creates the route. Routes target a service in\n the application. If an application does not have any routes, then the first route must be\n created as a DEFAULT\n RouteType.

\n

When you create a route, Refactor Spaces configures the Amazon API Gateway to send traffic\n to the target service as follows:

\n
    \n
  • \n

    If the service has a URL endpoint, and the endpoint resolves to a private IP address,\n Refactor Spaces routes traffic using the API Gateway VPC link.

    \n
    • \n
  • \n

    If the service has a URL endpoint, and the endpoint resolves to a public IP address,\n Refactor Spaces routes traffic over the public internet.

    \n
    • \n
  • \n

    If the service has an Lambda function endpoint, then Refactor Spaces uses\n the API Gateway\n Lambda integration.

    \n
    • \n
\n

A health check is performed on the service when the route is created. If the health check\n fails, the route transitions to FAILED, and no traffic is sent to the service.

\n

For Lambda functions, the Lambda function state is checked. If\n the function is not active, the function configuration is updated so that Lambda\n resources are provisioned. If the Lambda state is Failed, then the\n route creation fails. For more information, see the GetFunctionConfiguration's State response parameter in the Lambda Developer Guide.

\n

For public URLs, a connection is opened to the public endpoint. If the URL is not reachable,\n the health check fails. For private URLs, a target group is created and the target group\n health check is run.

\n

The HealthCheckProtocol, HealthCheckPort, and\n HealthCheckPath are the same protocol, port, and path specified in the URL or\n health URL, if used. All other settings use the default values, as described in Health checks\n for your target groups. The health check is considered successful if at least one\n target within the target group transitions to a healthy state.

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

Creates an Amazon Web Services Migration Hub Refactor Spaces route. The account owner of the service resource is always the\n environment owner, regardless of which account creates the route. Routes target a service in\n the application. If an application does not have any routes, then the first route must be\n created as a DEFAULT\n RouteType.

\n

When you create a route, Refactor Spaces configures the Amazon API Gateway to send traffic\n to the target service as follows:

\n
    \n
  • \n

    If the service has a URL endpoint, and the endpoint resolves to a private IP address,\n Refactor Spaces routes traffic using the API Gateway VPC link.

    \n
    • \n
  • \n

    If the service has a URL endpoint, and the endpoint resolves to a public IP address,\n Refactor Spaces routes traffic over the public internet.

    \n
    • \n
  • \n

    If the service has an Lambda function endpoint, then Refactor Spaces\n configures the Lambda function's resource policy to allow the application's\n API Gateway to invoke the function.

    \n
    • \n
\n

A one-time health check is performed on the service when the route is created. If the\n health check fails, the route transitions to FAILED, and no traffic is sent to\n the service.

\n

For Lambda functions, the Lambda function state is checked. If the\n function is not active, the function configuration is updated so that Lambda\n resources are provisioned. If the Lambda state is Failed, then the\n route creation fails. For more information, see the GetFunctionConfiguration's State response parameter in the Lambda Developer Guide.

\n

For public URLs, a connection is opened to the public endpoint. If the URL is not\n reachable, the health check fails. For private URLs, a target group is created and the target\n group health check is run.

\n

The HealthCheckProtocol, HealthCheckPort, and\n HealthCheckPath are the same protocol, port, and path specified in the URL or\n health URL, if used. All other settings use the default values, as described in Health checks\n for your target groups. The health check is considered successful if at least one\n target within the target group transitions to a healthy state.

\n

Services can have HTTP or HTTPS URL endpoints. For HTTPS URLs, publicly-signed\n certificates are supported. Private Certificate Authorities (CAs) are permitted only if the\n CA's domain is publicly resolvable.

", "smithy.api#http": { "method": "POST", "uri": "/environments/{EnvironmentIdentifier}/applications/{ApplicationIdentifier}/routes", @@ -853,7 +853,7 @@ "ServiceId": { "target": "com.amazonaws.migrationhubrefactorspaces#ServiceId", "traits": { - "smithy.api#documentation": "

The ID of service in which the rute iscreated. Traffic that matches this route is\n forwarded to this service.

" + "smithy.api#documentation": "

The ID of service in which the route is created. Traffic that matches this route is\n forwarded to this service.

" } }, "ApplicationId": { @@ -871,7 +871,7 @@ "State": { "target": "com.amazonaws.migrationhubrefactorspaces#RouteState", "traits": { - "smithy.api#documentation": "

he current state of the route.

" + "smithy.api#documentation": "

The current state of the route.

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

Creates an Amazon Web Services Migration Hub Refactor Spaces service. The account owner of the service is always the\n environment owner, regardless of which account in the environment creates the service.\n Services have either a URL endpoint in a virtual private cloud (VPC), or a Lambda\n function endpoint.

\n \n

If an Amazon Web Services resourceis launched in a service VPC, and you want it to be\n accessible to all of an environment’s services with VPCs and routes, apply the\n RefactorSpacesSecurityGroup to the resource. Alternatively, to add more\n cross-account constraints, apply your own security group.

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

Creates an Amazon Web Services Migration Hub Refactor Spaces service. The account owner of the service is always the\n environment owner, regardless of which account in the environment creates the service.\n Services have either a URL endpoint in a virtual private cloud (VPC), or a Lambda\n function endpoint.

\n \n

If an Amazon Web Services resource is launched in a service VPC, and you want it to be\n accessible to all of an environment’s services with VPCs and routes, apply the\n RefactorSpacesSecurityGroup to the resource. Alternatively, to add more\n cross-account constraints, apply your own security group.

\n ", "smithy.api#http": { "method": "POST", "uri": "/environments/{EnvironmentIdentifier}/applications/{ApplicationIdentifier}/services", @@ -1436,7 +1436,7 @@ "ApplicationId": { "target": "com.amazonaws.migrationhubrefactorspaces#ApplicationId", "traits": { - "smithy.api#documentation": "

he ID of the application that the route belongs to.

" + "smithy.api#documentation": "

The ID of the application that the route belongs to.

" } }, "State": { @@ -1713,7 +1713,7 @@ } }, "traits": { - "smithy.api#documentation": "

The summary information for environments as a response to ListEnvironments.

" + "smithy.api#documentation": "

The summary information for environments as a response to ListEnvironments.\n

" } }, "com.amazonaws.migrationhubrefactorspaces#EnvironmentVpc": { @@ -2038,7 +2038,7 @@ "OwnerAccountId": { "target": "com.amazonaws.migrationhubrefactorspaces#AccountId", "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID of the application owner.

" + "smithy.api#documentation": "

The Amazon Web Services account ID of the application owner (which is always the same as\n the environment owner account ID).

" } }, "CreatedByAccountId": { @@ -2802,8 +2802,8 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "ApplicationSummaryList", - "pageSize": "MaxResults" + "pageSize": "MaxResults", + "items": "ApplicationSummaryList" }, "smithy.api#readonly": {} } @@ -2878,7 +2878,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all the virtual private clouds (VPCs) that are part of an Amazon Web Services Migration Hub Refactor Spaces environment.

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

Lists all Amazon Web Services Migration Hub Refactor Spaces service virtual private clouds (VPCs) that are part of the\n environment.

", "smithy.api#http": { "method": "GET", "uri": "/environments/{EnvironmentIdentifier}/vpcs", @@ -2887,8 +2887,8 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "EnvironmentVpcList", - "pageSize": "MaxResults" + "pageSize": "MaxResults", + "items": "EnvironmentVpcList" }, "smithy.api#readonly": {} } @@ -2972,8 +2972,8 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "EnvironmentSummaryList", - "pageSize": "MaxResults" + "pageSize": "MaxResults", + "items": "EnvironmentSummaryList" }, "smithy.api#readonly": {} } @@ -3055,8 +3055,8 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "RouteSummaryList", - "pageSize": "MaxResults" + "pageSize": "MaxResults", + "items": "RouteSummaryList" }, "smithy.api#readonly": {} } @@ -3154,8 +3154,8 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "ServiceSummaryList", - "pageSize": "MaxResults" + "pageSize": "MaxResults", + "items": "ServiceSummaryList" }, "smithy.api#readonly": {} } @@ -3235,8 +3235,7 @@ "smithy.api#documentation": "

Lists the tags of a resource. The caller account must be the same as the resource’s\n OwnerAccountId. Listing tags in other accounts is not supported.

", "smithy.api#http": { "method": "GET", - "uri": "/tags/{ResourceArn}", - "code": 200 + "uri": "/tags/{ResourceArn}" }, "smithy.api#readonly": {} } @@ -3394,7 +3393,7 @@ } ], "traits": { - "smithy.api#documentation": "

Attaches a resource-based permission policy to the Amazon Web Services Migration Hub Refactor Spaces environment. The policy\n must contain the same actions and condition statements as the\n arn:aws:ram::aws:permission/AWSRAMDefaultPermissionRefactorSpacesEnvironment\n permission in Resource Access Manager. The policy must not contain new lines or blank lines.

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

Attaches a resource-based permission policy to the Amazon Web Services Migration Hub Refactor Spaces environment. The policy\n must contain the same actions and condition statements as the\n arn:aws:ram::aws:permission/AWSRAMDefaultPermissionRefactorSpacesEnvironment\n permission in Resource Access Manager. The policy must not contain new lines or blank lines.\n

", "smithy.api#http": { "method": "PUT", "uri": "/resourcepolicy", @@ -3431,29 +3430,27 @@ "traits": { "aws.api#service": { "sdkId": "Migration Hub Refactor Spaces", - "arnNamespace": "refactor-spaces", - "cloudFormationName": "RefactorSpaces", - "cloudTrailEventSource": "refactor-spaces.amazonaws.com", - "endpointPrefix": "refactor-spaces" + "arnNamespace": "refactor-spaces" }, "aws.auth#sigv4": { "name": "refactor-spaces" }, "aws.protocols#restJson1": {}, "smithy.api#cors": { - "additionalAllowedHeaders": [ - "content-type" - ], "additionalExposedHeaders": [ - "date", - "x-amz-apigw-id", - "x-amzn-trace-id", "x-amzn-errortype", "x-amzn-requestid", - "x-amzn-errormessage" - ] + "x-amzn-errormessage", + "x-amzn-trace-id", + "x-amz-apigw-id", + "date" + ], + "additionalAllowedHeaders": [ + "content-type" + ], + "origin": "*" }, - "smithy.api#documentation": "Amazon Web Services Migration Hub Refactor Spaces\n\n

This API reference provides descriptions, syntax, and other details about each of the\n actions and data types for Amazon Web Services Migration Hub Refactor Spaces (Refactor Spaces). The topic for each action shows the API\n request parameters and the response. Alternatively, you can use one of the Amazon Web Services SDKs to\n access an API that is tailored to the programming language or platform that you're using. For\n more information, see Amazon Web Services SDKs.

", + "smithy.api#documentation": "Amazon Web Services Migration Hub Refactor Spaces\n \n

This API reference provides descriptions, syntax, and other details about each of the\n actions and data types for Amazon Web Services Migration Hub Refactor Spaces (Refactor Spaces). The topic for each action shows the API\n request parameters and the response. Alternatively, you can use one of the Amazon Web Services SDKs to\n access an API that is tailored to the programming language or platform that you're using. For\n more information, see Amazon Web Services SDKs.

\n \n

To share Refactor Spaces environments with other Amazon Web Services accounts or with Organizations\n and their OUs, use Resource Access Manager's CreateResourceShare API. See CreateResourceShare in the Amazon Web Services RAM API Reference.

", "smithy.api#title": "AWS Migration Hub Refactor Spaces" }, "version": "2021-10-26", @@ -4065,8 +4062,7 @@ "smithy.api#documentation": "

Removes the tags of a given resource. Tags are metadata which can be used to manage a\n resource. To tag a resource, the caller account must be the same as the resource’s\n OwnerAccountId. Tagging resources in other accounts is not supported.

\n \n

Amazon Web Services Migration Hub Refactor Spaces does not propagate tags to orchestrated resources, such as an\n environment’s transit gateway.

\n ", "smithy.api#http": { "method": "POST", - "uri": "/tags/{ResourceArn}", - "code": 200 + "uri": "/tags/{ResourceArn}" } } }, @@ -4165,8 +4161,7 @@ "smithy.api#documentation": "

Adds to or modifies the tags of the given resource. Tags are metadata which can be used to\n manage a resource. To untag a resource, the caller account must be the same as the resource’s\n OwnerAccountId. Untagging resources across accounts is not supported.

", "smithy.api#http": { "method": "DELETE", - "uri": "/tags/{ResourceArn}", - "code": 200 + "uri": "/tags/{ResourceArn}" }, "smithy.api#idempotent": {} } @@ -4229,7 +4224,7 @@ "ActivationState": { "target": "com.amazonaws.migrationhubrefactorspaces#RouteActivationState", "traits": { - "smithy.api#documentation": "

Indicates whether traffic is forwarded to this route’s service after the route is created.

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

Indicates whether traffic is forwarded to this route’s service after the route is created.\n

", "smithy.api#required": {} } }, @@ -4322,7 +4317,7 @@ } }, "traits": { - "smithy.api#documentation": "

The input does not satisfy the constraints specified by an Amazon Web Service.

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

The input does not satisfy the constraints specified by an Amazon Web Service.\n

", "smithy.api#error": "client", "smithy.api#httpError": 400 } diff --git a/aws/sdk/aws-models/models.lex.v2.json b/aws/sdk/aws-models/models.lex.v2.json index 55b86822d7..005dbdc050 100644 --- a/aws/sdk/aws-models/models.lex.v2.json +++ b/aws/sdk/aws-models/models.lex.v2.json @@ -2902,8 +2902,7 @@ "slotTypeId": { "target": "com.amazonaws.lexmodelsv2#BuiltInOrCustomSlotTypeId", "traits": { - "smithy.api#documentation": "

The unique identifier for the slot type associated with this slot.\n The slot type determines the values that can be entered into the\n slot.

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

The unique identifier for the slot type associated with this slot.\n The slot type determines the values that can be entered into the\n slot.

" } }, "valueElicitationSetting": { @@ -12609,8 +12608,7 @@ "slotTypeId": { "target": "com.amazonaws.lexmodelsv2#BuiltInOrCustomSlotTypeId", "traits": { - "smithy.api#documentation": "

The unique identifier of the new slot type to associate with this\n slot.

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

The unique identifier of the new slot type to associate with this\n slot.

" } }, "valueElicitationSetting": { diff --git a/aws/sdk/aws-models/outposts.json b/aws/sdk/aws-models/outposts.json index 06c6ce89a6..089898d649 100644 --- a/aws/sdk/aws-models/outposts.json +++ b/aws/sdk/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/aws/sdk/aws-models/panorama.json b/aws/sdk/aws-models/panorama.json index c924d997e9..7737e040be 100644 --- a/aws/sdk/aws-models/panorama.json +++ b/aws/sdk/aws-models/panorama.json @@ -1,33 +1,5 @@ { "smithy": "1.0", - "metadata": { - "suppressions": [ - { - "id": "HttpMethodSemantics", - "namespace": "*" - }, - { - "id": "HttpResponseCodeSemantics", - "namespace": "*" - }, - { - "id": "PaginatedTrait", - "namespace": "*" - }, - { - "id": "HttpHeaderTrait", - "namespace": "*" - }, - { - "id": "HttpUriConflict", - "namespace": "*" - }, - { - "id": "Service", - "namespace": "*" - } - ] - }, "shapes": { "com.amazonaws.panorama#AccessDeniedException": { "type": "structure", @@ -45,6 +17,26 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.panorama#AlternateSoftwareMetadata": { + "type": "structure", + "members": { + "Version": { + "target": "com.amazonaws.panorama#Version", + "traits": { + "smithy.api#documentation": "

The appliance software version.

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

Details about a beta appliance software update.

" + } + }, + "com.amazonaws.panorama#AlternateSoftwares": { + "type": "list", + "member": { + "target": "com.amazonaws.panorama#AlternateSoftwareMetadata" + } + }, "com.amazonaws.panorama#ApplicationInstance": { "type": "structure", "members": { @@ -230,10 +222,7 @@ } }, "com.amazonaws.panorama#Boolean": { - "type": "boolean", - "traits": { - "smithy.api#box": {} - } + "type": "boolean" }, "com.amazonaws.panorama#Bucket": { "type": "string" @@ -882,7 +871,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a package.

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

Deletes a package.

\n \n

To delete a package, you need permission to call s3:DeleteObject\n in addition to permissions for the AWS Panorama API.

\n ", "smithy.api#http": { "method": "DELETE", "uri": "/packages/{PackageId}", @@ -1467,6 +1456,18 @@ "traits": { "smithy.api#documentation": "

The device's lease expiration time.

" } + }, + "AlternateSoftwares": { + "target": "com.amazonaws.panorama#AlternateSoftwares", + "traits": { + "smithy.api#documentation": "

Beta software releases available for the device.

" + } + }, + "LatestAlternateSoftware": { + "target": "com.amazonaws.panorama#LatestAlternateSoftware", + "traits": { + "smithy.api#documentation": "

The most recent beta software release.

" + } } } }, @@ -2488,6 +2489,16 @@ "smithy.api#pattern": "^((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d))(:(6553[0-5]|655[0-2]\\d|65[0-4]\\d{2}|6[0-4]\\d{3}|[1-5]\\d{4}|[1-9]\\d{0,3}))?$" } }, + "com.amazonaws.panorama#IpAddressOrServerName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "(^([a-z0-9]+(-[a-z0-9]+)*\\.)+[a-z]{2,}$)|(^((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d))(:(6553[0-5]|655[0-2]\\d|65[0-4]\\d{2}|6[0-4]\\d{3}|[1-5]\\d{4}|[1-9]\\d{0,3}))?$)" + } + }, "com.amazonaws.panorama#Job": { "type": "structure", "members": { @@ -2577,6 +2588,15 @@ "com.amazonaws.panorama#LastUpdatedTime": { "type": "timestamp" }, + "com.amazonaws.panorama#LatestAlternateSoftware": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, "com.amazonaws.panorama#LatestSoftware": { "type": "string", "traits": { @@ -3398,10 +3418,7 @@ } }, "com.amazonaws.panorama#MarkLatestPatch": { - "type": "boolean", - "traits": { - "smithy.api#box": {} - } + "type": "boolean" }, "com.amazonaws.panorama#Mask": { "type": "string", @@ -3436,6 +3453,10 @@ { "value": "NOT_CONNECTED", "name": "NOT_CONNECTED" + }, + { + "value": "CONNECTING", + "name": "CONNECTING" } ] } @@ -3454,6 +3475,12 @@ "traits": { "smithy.api#documentation": "

Settings for Ethernet port 1.

" } + }, + "Ntp": { + "target": "com.amazonaws.panorama#NtpPayload", + "traits": { + "smithy.api#documentation": "

Network time protocol (NTP) server settings.

" + } } }, "traits": { @@ -3474,6 +3501,18 @@ "traits": { "smithy.api#documentation": "

The status of Ethernet port 1.

" } + }, + "NtpStatus": { + "target": "com.amazonaws.panorama#NtpStatus", + "traits": { + "smithy.api#documentation": "

Details about a network time protocol (NTP) server connection.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.panorama#LastUpdatedTime", + "traits": { + "smithy.api#documentation": "

When the network status changed.

" + } } }, "traits": { @@ -3925,6 +3964,67 @@ "target": "com.amazonaws.panorama#Node" } }, + "com.amazonaws.panorama#NtpPayload": { + "type": "structure", + "members": { + "NtpServers": { + "target": "com.amazonaws.panorama#NtpServerList", + "traits": { + "smithy.api#documentation": "

NTP servers to use, in order of preference.

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

Network time protocol (NTP) server settings. Use this option to connect to local NTP\n servers instead of pool.ntp.org.

" + } + }, + "com.amazonaws.panorama#NtpServerList": { + "type": "list", + "member": { + "target": "com.amazonaws.panorama#IpAddressOrServerName" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.panorama#NtpServerName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.panorama#NtpStatus": { + "type": "structure", + "members": { + "ConnectionStatus": { + "target": "com.amazonaws.panorama#NetworkConnectionStatus", + "traits": { + "smithy.api#documentation": "

The connection's status.

" + } + }, + "IpAddress": { + "target": "com.amazonaws.panorama#IpAddress", + "traits": { + "smithy.api#documentation": "

The IP address of the server.

" + } + }, + "NtpServerName": { + "target": "com.amazonaws.panorama#NtpServerName", + "traits": { + "smithy.api#documentation": "

The domain name of the server.

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

Details about an NTP server connection.

" + } + }, "com.amazonaws.panorama#OTAJobConfig": { "type": "structure", "members": { @@ -3955,6 +4055,22 @@ }, "com.amazonaws.panorama#OmniCloudServiceLambda": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Panorama", + "arnNamespace": "panorama", + "cloudFormationName": "OmniCloudServiceLambda", + "cloudTrailEventSource": "panorama.amazonaws.com", + "endpointPrefix": "panorama" + }, + "aws.auth#sigv4": { + "name": "panorama" + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": {}, + "smithy.api#documentation": "AWS Panorama\n

\n Overview\n

\n

This is the AWS Panorama API Reference. For an introduction to the service, see \n What is AWS Panorama? \n in the AWS Panorama Developer Guide.

", + "smithy.api#title": "AWS Panorama" + }, "version": "2019-07-24", "operations": [ { @@ -4056,22 +4172,7 @@ { "target": "com.amazonaws.panorama#UpdateDeviceMetadata" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Panorama", - "arnNamespace": "panorama", - "cloudFormationName": "Panorama", - "cloudTrailEventSource": "panorama.amazonaws.com", - "endpointPrefix": "panorama" - }, - "aws.auth#sigv4": { - "name": "panorama" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "AWS Panorama\n

\n Overview\n

\n

This is the AWS Panorama API Reference. For an introduction to the service, see \n What is AWS Panorama? \n in the AWS Panorama Developer Guide.

", - "smithy.api#title": "AWS Panorama" - } + ] }, "com.amazonaws.panorama#OutPutS3Location": { "type": "structure", @@ -4244,6 +4345,10 @@ { "value": "NODE_PACKAGE_VERSION", "name": "NODE_PACKAGE_VERSION" + }, + { + "value": "MARKETPLACE_NODE_PACKAGE_VERSION", + "name": "MARKETPLACE_NODE_PACKAGE_VERSION" } ] } @@ -5374,6 +5479,15 @@ } ] } + }, + "com.amazonaws.panorama#Version": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } } } } diff --git a/aws/sdk/aws-models/rds.json b/aws/sdk/aws-models/rds.json index 19fc883ac6..9a44a1ad8d 100644 --- a/aws/sdk/aws-models/rds.json +++ b/aws/sdk/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
  • \n

    \n AllocatedStorage - The total allocated storage per account, in GiB.\n The used value is the total allocated storage in the account, in GiB.

    \n
    • \n
  • \n

    \n AuthorizationsPerDBSecurityGroup - The number of ingress rules per DB security group. \n The used value is the highest number of ingress rules in a DB security group in the account. Other \n DB security groups in the account might have a lower number of ingress rules.

    \n
    • \n
  • \n

    \n CustomEndpointsPerDBCluster - The number of custom endpoints per DB cluster. \n The used value is the highest number of custom endpoints in a DB clusters in the account. Other \n DB clusters in the account might have a lower number of custom endpoints.

    \n
    • \n
  • \n

    \n DBClusterParameterGroups - The number of DB cluster parameter groups\n per account, excluding default parameter groups. The used value is the count of\n nondefault DB cluster parameter groups in the account.

    \n
    • \n
  • \n

    \n DBClusterRoles - The number of associated Amazon Web Services Identity and Access Management (IAM) roles per DB cluster. \n The used value is the highest number of associated IAM roles for a DB cluster in the account. Other \n DB clusters in the account might have a lower number of associated IAM roles.

    \n
    • \n
  • \n

    \n DBClusters - The number of DB clusters per account. \n The used value is the count of DB clusters in the account.

    \n
    • \n
  • \n

    \n DBInstanceRoles - The number of associated IAM roles per DB instance. \n The used value is the highest number of associated IAM roles for a DB instance in the account. Other \n DB instances in the account might have a lower number of associated IAM roles.

    \n
    • \n
  • \n

    \n DBInstances - The number of DB instances per account. \n The used value is the count of the DB instances in the account.

    \n

    Amazon RDS DB instances, Amazon Aurora DB instances, Amazon Neptune instances, and Amazon DocumentDB \n instances apply to this quota.

    \n
    • \n
  • \n

    \n DBParameterGroups - The number of DB parameter groups per account,\n excluding default parameter groups. The used value is the count of nondefault DB\n parameter groups in the account.

    \n
    • \n
  • \n

    \n DBSecurityGroups - The number of DB security groups (not VPC\n security groups) per account, excluding the default security group. The used\n value is the count of nondefault DB security groups in the account.

    \n
    • \n
  • \n

    \n DBSubnetGroups - The number of DB subnet groups per account. \n The used value is the count of the DB subnet groups in the account.

    \n
    • \n
  • \n

    \n EventSubscriptions - The number of event subscriptions per account. \n The used value is the count of the event subscriptions in the account.

    \n
    • \n
  • \n

    \n ManualClusterSnapshots - The number of manual DB cluster snapshots per account. \n The used value is the count of the manual DB cluster snapshots in the account.

    \n
    • \n
  • \n

    \n ManualSnapshots - The number of manual DB instance snapshots per account. \n The used value is the count of the manual DB instance snapshots in the account.

    \n
    • \n
  • \n

    \n OptionGroups - The number of DB option groups per account, excluding\n default option groups. The used value is the count of nondefault DB option\n groups in the account.

    \n
    • \n
  • \n

    \n ReadReplicasPerMaster - The number of read replicas per DB\n instance. The used value is the highest number of read replicas for a DB\n instance in the account. Other DB instances in the account might have a lower\n number of read replicas.

    \n
    • \n
  • \n

    \n ReservedDBInstances - The number of reserved DB instances per account. \n The used value is the count of the active reserved DB instances in the account.

    \n
    • \n
  • \n

    \n SubnetsPerDBSubnetGroup - The number of subnets per DB subnet group. \n The used value is highest number of subnets for a DB subnet group in the account. Other \n DB subnet groups in the account might have a lower number of subnets.

    \n
    • \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
  • \n

    \n AllocatedStorage - The total allocated storage per account, in GiB.\n The used value is the total allocated storage in the account, in GiB.

    \n
    • \n
  • \n

    \n AuthorizationsPerDBSecurityGroup - The number of ingress rules per DB security group. \n The used value is the highest number of ingress rules in a DB security group in the account. Other \n DB security groups in the account might have a lower number of ingress rules.

    \n
    • \n
  • \n

    \n CustomEndpointsPerDBCluster - The number of custom endpoints per DB cluster. \n The used value is the highest number of custom endpoints in a DB clusters in the account. Other \n DB clusters in the account might have a lower number of custom endpoints.

    \n
    • \n
  • \n

    \n DBClusterParameterGroups - The number of DB cluster parameter groups\n per account, excluding default parameter groups. The used value is the count of\n nondefault DB cluster parameter groups in the account.

    \n
    • \n
  • \n

    \n DBClusterRoles - The number of associated Amazon Web Services Identity and Access Management (IAM) roles per DB cluster. \n The used value is the highest number of associated IAM roles for a DB cluster in the account. Other \n DB clusters in the account might have a lower number of associated IAM roles.

    \n
    • \n
  • \n

    \n DBClusters - The number of DB clusters per account. \n The used value is the count of DB clusters in the account.

    \n
    • \n
  • \n

    \n DBInstanceRoles - The number of associated IAM roles per DB instance. \n The used value is the highest number of associated IAM roles for a DB instance in the account. Other \n DB instances in the account might have a lower number of associated IAM roles.

    \n
    • \n
  • \n

    \n DBInstances - The number of DB instances per account. \n The used value is the count of the DB instances in the account.

    \n

    Amazon RDS DB instances, Amazon Aurora DB instances, Amazon Neptune instances, and Amazon DocumentDB \n instances apply to this quota.

    \n
    • \n
  • \n

    \n DBParameterGroups - The number of DB parameter groups per account,\n excluding default parameter groups. The used value is the count of nondefault DB\n parameter groups in the account.

    \n
    • \n
  • \n

    \n DBSecurityGroups - The number of DB security groups (not VPC\n security groups) per account, excluding the default security group. The used\n value is the count of nondefault DB security groups in the account.

    \n
    • \n
  • \n

    \n DBSubnetGroups - The number of DB subnet groups per account. \n The used value is the count of the DB subnet groups in the account.

    \n
    • \n
  • \n

    \n EventSubscriptions - The number of event subscriptions per account. \n The used value is the count of the event subscriptions in the account.

    \n
    • \n
  • \n

    \n ManualClusterSnapshots - The number of manual DB cluster snapshots per account. \n The used value is the count of the manual DB cluster snapshots in the account.

    \n
    • \n
  • \n

    \n ManualSnapshots - The number of manual DB instance snapshots per account. \n The used value is the count of the manual DB instance snapshots in the account.

    \n
    • \n
  • \n

    \n OptionGroups - The number of DB option groups per account, excluding\n default option groups. The used value is the count of nondefault DB option\n groups in the account.

    \n
    • \n
  • \n

    \n ReadReplicasPerMaster - The number of read replicas per DB\n instance. The used value is the highest number of read replicas for a DB\n instance in the account. Other DB instances in the account might have a lower\n number of read replicas.

    \n
    • \n
  • \n

    \n ReservedDBInstances - The number of reserved DB instances per account. \n The used value is the count of the active reserved DB instances in the account.

    \n
    • \n
  • \n

    \n SubnetsPerDBSubnetGroup - The number of subnets per DB subnet group. \n The used value is highest number of subnets for a DB subnet group in the account. Other \n DB subnet groups in the account might have a lower number of subnets.

    \n
    • \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
    \n
  • \n

    If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is an RDS Proxy, a DBProxyName value must be supplied.

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

The identifier of the event source to be added.

\n

Constraints:

\n
    \n
  • \n

    If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is an RDS Proxy, a DBProxyName value must be supplied.

    \n
    • \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

    For the alphabetical list of API actions, see \n API Actions.

    \n
    • \n
  • \n

    For the alphabetical list of data types, see \n Data Types.

    \n
    • \n
  • \n

    For a list of common query parameters, see \n Common Parameters.

    \n
    • \n
  • \n

    For descriptions of the error codes, see \n Common Errors.

    \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

    For the alphabetical list of API actions, see \n API Actions.

    \n
    • \n
  • \n

    For the alphabetical list of data types, see \n Data Types.

    \n
    • \n
  • \n

    For a list of common query parameters, see \n Common Parameters.

    \n
    • \n
  • \n

    For descriptions of the error codes, see \n Common Errors.

    \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
    \n
  • \n

    \n immediate - Apply the maintenance action immediately.

    \n
    • \n
  • \n

    \n next-maintenance - Apply the maintenance action during\n the next maintenance window for the resource.

    \n
    • \n
  • \n

    \n undo-opt-in - Cancel any existing next-maintenance\n opt-in requests.

    \n
    • \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
    \n
  • \n

    \n immediate - Apply the maintenance action immediately.

    \n
    • \n
  • \n

    \n next-maintenance - Apply the maintenance action during\n the next maintenance window for the resource.

    \n
    • \n
  • \n

    \n undo-opt-in - Cancel any existing next-maintenance\n opt-in requests.

    \n
    • \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
  • \n

    Must contain from 1 to 63 alphanumeric characters or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \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
  • \n

    Must contain from 1 to 63 alphanumeric characters or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \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
    \n
  • \n

    Must specify a valid DB cluster parameter group.

    \n
    • \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
    \n
  • \n

    Must specify a valid DB cluster parameter group.

    \n
    • \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
  • \n

    Can't be null, empty, or blank

    \n
    • \n
  • \n

    Must contain from 1 to 255 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
\n

Example: my-cluster-param-group1\n

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

The identifier for the copied DB cluster parameter group.

\n

Constraints:

\n
    \n
  • \n

    Can't be null, empty, or blank

    \n
    • \n
  • \n

    Must contain from 1 to 255 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \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
  • \n

    \n KmsKeyId - The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to \n encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region.

    \n
    • \n
  • \n

    \n PreSignedUrl - A URL that contains a Signature Version 4 signed request for the \n CopyDBClusterSnapshot action to be called in the source Amazon Web Services Region where the DB cluster snapshot is copied from. \n The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the \n 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 KmsKeyId - The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of the DB \n cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBClusterSnapshot \n action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL.

      \n
      • \n
    • \n

      \n DestinationRegion - The name of the Amazon Web Services Region that the DB cluster snapshot is to be created in.

      \n
      • \n
    • \n

      \n SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster \n snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, \n if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier\n looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.

      \n
      • \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
    • \n
  • \n

    \n TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region.

    \n
    • \n
  • \n

    \n SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. \n This identifier must be in the ARN format for the source Amazon Web Services Region and is the same value as the SourceDBClusterSnapshotIdentifier in the pre-signed URL.

    \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

\n \n

The Multi-AZ DB clusters feature is in preview and is subject to change.

\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
  • \n

    \n KmsKeyId - The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to \n encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region.

    \n
    • \n
  • \n

    \n PreSignedUrl - A URL that contains a Signature Version 4 signed request for the \n CopyDBClusterSnapshot action to be called in the source Amazon Web Services Region where the DB cluster snapshot is copied from. \n The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the \n 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 KmsKeyId - The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of the DB \n cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBClusterSnapshot \n action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL.

      \n
      • \n
    • \n

      \n DestinationRegion - The name of the Amazon Web Services Region that the DB cluster snapshot is to be created in.

      \n
      • \n
    • \n

      \n SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster \n snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, \n if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier\n looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.

      \n
      • \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
    • \n
  • \n

    \n TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region.

    \n
    • \n
  • \n

    \n SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. \n This identifier must be in the ARN format for the source Amazon Web Services Region and is the same value as the SourceDBClusterSnapshotIdentifier in the pre-signed URL.

    \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

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
  • \n

    Must specify a valid system snapshot in the \"available\" state.

    \n
    • \n
  • \n

    If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB snapshot identifier.

    \n
    • \n
  • \n

    If the source snapshot is in a different Amazon Web Services Region than the copy,\n specify a valid DB cluster snapshot ARN. For more information, go to\n \n Copying Snapshots Across Amazon Web Services Regions in the Amazon Aurora User Guide.\n

    \n
    • \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
  • \n

    Must specify a valid system snapshot in the \"available\" state.

    \n
    • \n
  • \n

    If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB snapshot identifier.

    \n
    • \n
  • \n

    If the source snapshot is in a different Amazon Web Services Region than the copy,\n specify a valid DB cluster snapshot ARN. For more information, go to\n \n Copying Snapshots Across Amazon Web Services Regions in the Amazon Aurora User Guide.

    \n
    • \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
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \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
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \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

    \n KmsKeyId - The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of the DB \n cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBClusterSnapshot \n action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL.

    \n
    • \n
  • \n

    \n DestinationRegion - The name of the Amazon Web Services Region that the DB cluster snapshot is to be created in.

    \n
    • \n
  • \n

    \n SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster \n snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, \n if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier\n looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.

    \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
  • \n

    \n KmsKeyId - The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of the DB \n cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBClusterSnapshot \n action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL.

    \n
    • \n
  • \n

    \n DestinationRegion - The name of the Amazon Web Services Region that the DB cluster snapshot is to be created in.

    \n
    • \n
  • \n

    \n SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster \n snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, \n if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier\n looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.

    \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

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
    \n
  • \n

    Must specify a valid DB parameter group.

    \n
    • \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
    \n
  • \n

    Must specify a valid DB parameter group.

    \n
    • \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
  • \n

    Can't be null, empty, or blank

    \n
    • \n
  • \n

    Must contain from 1 to 255 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
\n

Example: my-db-parameter-group\n

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

The identifier for the copied DB parameter group.

\n

Constraints:

\n
    \n
  • \n

    Can't be null, empty, or blank

    \n
    • \n
  • \n

    Must contain from 1 to 255 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \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

    Must specify a valid system snapshot in the \"available\" state.

    \n
    • \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
  • \n

    Must specify a valid system snapshot in the \"available\" state.

    \n
    • \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

    Can't be null, empty, or blank

    \n
    • \n
  • \n

    Must contain from 1 to 255 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
\n\n

Example: my-db-snapshot\n

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

The identifier for the copy of the snapshot.

\n

Constraints:

\n
    \n
  • \n

    Can't be null, empty, or blank

    \n
    • \n
  • \n

    Must contain from 1 to 255 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \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

    \n DestinationRegion - The Amazon Web Services Region that the encrypted DB snapshot is copied to. \n This Amazon Web Services Region is the same one where the CopyDBSnapshot action is called that contains this presigned URL.\n

    \n\n

    For example, if you copy an encrypted DB snapshot from the us-west-2 Amazon Web Services Region\n to the us-east-1 Amazon Web Services Region, then you call the CopyDBSnapshot action in\n the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the\n CopyDBSnapshot action in the us-west-2 Amazon Web Services Region. For this\n example, the DestinationRegion in the presigned URL must be set to\n the us-east-1 Amazon Web Services Region.

    \n
    • \n
  • \n

    \n KmsKeyId - The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of the DB snapshot in the destination Amazon Web Services Region. \n This is the same identifier for both the CopyDBSnapshot action that is called in the destination Amazon Web Services Region, \n and the action contained in the presigned URL.\n

    \n
    • \n
  • \n

    \n SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied. \n This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. \n For example, if you are copying an encrypted DB snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBSnapshotIdentifier looks like\n the following example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.\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
  • \n

    \n DestinationRegion - The Amazon Web Services Region that the encrypted DB snapshot is copied to. \n This Amazon Web Services Region is the same one where the CopyDBSnapshot action is called that contains this presigned URL.

    \n

    For example, if you copy an encrypted DB snapshot from the us-west-2 Amazon Web Services Region\n to the us-east-1 Amazon Web Services Region, then you call the CopyDBSnapshot action in\n the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the\n CopyDBSnapshot action in the us-west-2 Amazon Web Services Region. For this\n example, the DestinationRegion in the presigned URL must be set to\n the us-east-1 Amazon Web Services Region.

    \n
    • \n
  • \n

    \n KmsKeyId - The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of the DB snapshot in the destination Amazon Web Services Region. \n This is the same identifier for both the CopyDBSnapshot action that is called in the destination Amazon Web Services Region, \n and the action contained in the presigned URL.

    \n
    • \n
  • \n

    \n SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied. \n This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. \n For example, if you are copying an encrypted DB snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBSnapshotIdentifier looks like\n the following example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.

    \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

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
    \n
  • \n

    Must specify a valid option group.

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

The identifier for the source option group.

\n

Constraints:

\n
    \n
  • \n

    Must specify a valid option group.

    \n
    • \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
  • \n

    Can't be null, empty, or blank

    \n
    • \n
  • \n

    Must contain from 1 to 255 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
\n

Example: my-option-group\n

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

The identifier for the copied option group.

\n

Constraints:

\n
    \n
  • \n

    Can't be null, empty, or blank

    \n
    • \n
  • \n

    Must contain from 1 to 255 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \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
  • \n

    Oracle Database 12.1 Enterprise Edition with the January 2021 or later RU/RUR

    \n
    • \n
  • \n

    Oracle Database 19c Enterprise Edition with the January 2021 or later RU/RUR

    \n
    • \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
  • \n

    Oracle Database 12.1 Enterprise Edition with the January 2021 or later RU/RUR

    \n
    • \n
  • \n

    Oracle Database 19c Enterprise Edition with the January 2021 or later RU/RUR

    \n
    • \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

\n \n

The Multi-AZ DB clusters feature is in preview and is subject to change.

\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
  • \n

    Must be a value from 1 to 35

    \n
    • \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
  • \n

    Must be a value from 1 to 35

    \n
    • \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
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \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
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \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
  • \n

    If supplied, must match the name of an existing DB cluster parameter group.

    \n
    • \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
  • \n

    If supplied, must match the name of an existing DB cluster parameter group.

    \n
    • \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
  • \n

    \n aurora (for MySQL 5.6-compatible Aurora)

    \n
    • \n
  • \n

    \n aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)

    \n
    • \n
  • \n

    \n aurora-postgresql\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \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
  • \n

    \n aurora (for MySQL 5.6-compatible Aurora)

    \n
    • \n
  • \n

    \n aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)

    \n
    • \n
  • \n

    \n aurora-postgresql\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \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
  • \n

    Must be 1 to 16 letters or numbers.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't be a reserved word for the chosen database engine.

    \n
    • \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
  • \n

    Must be 1 to 16 letters or numbers.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't be a reserved word for the chosen database engine.

    \n
    • \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
  • \n

    Must be in the format hh24:mi-hh24:mi.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred maintenance window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \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
  • \n

    Must be in the format hh24:mi-hh24:mi.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred maintenance window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \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
  • \n

    If ReplicationSourceIdentifier identifies an encrypted\n source, then Amazon RDS will use the KMS key used to encrypt the\n source. Otherwise, Amazon RDS will use your default KMS key.

    \n
    • \n
  • \n

    If the StorageEncrypted parameter is enabled and\n ReplicationSourceIdentifier isn't specified, then Amazon RDS\n will use your default KMS key.

    \n
    • \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
  • \n

    If ReplicationSourceIdentifier identifies an encrypted\n source, then Amazon RDS will use the KMS key used to encrypt the\n source. Otherwise, Amazon RDS will use your default KMS key.

    \n
    • \n
  • \n

    If the StorageEncrypted parameter is enabled and\n ReplicationSourceIdentifier isn't specified, then Amazon RDS\n will use your default KMS key.

    \n
    • \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
  • \n

    \n KmsKeyId - The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of \n the DB cluster in the destination Amazon Web Services Region. This should refer to the same KMS key for both the CreateDBCluster \n action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL.

    \n
    • \n
  • \n

    \n DestinationRegion - The name of the Amazon Web Services Region that Aurora read replica will\n be created in.

    \n
    • \n
  • \n

    \n ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. \n This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an \n encrypted DB cluster from the us-west-2 Amazon Web Services Region, then your ReplicationSourceIdentifier would look like\n Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.

    \n
    • \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
  • \n

    \n KmsKeyId - The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of \n the DB cluster in the destination Amazon Web Services Region. This should refer to the same KMS key for both the CreateDBCluster \n action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL.

    \n
    • \n
  • \n

    \n DestinationRegion - The name of the Amazon Web Services Region that Aurora read replica will\n be created in.

    \n
    • \n
  • \n

    \n ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. \n This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an \n encrypted DB cluster from the us-west-2 Amazon Web Services Region, then your ReplicationSourceIdentifier would look like\n Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.

    \n
    • \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
  • \n

    If specified, this value must be set to a number from 0 to 259,200 (72 hours).

    \n
    • \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
  • \n

    If specified, this value must be set to a number from 0 to 259,200 (72 hours).

    \n
    • \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. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

\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

Valid for: Aurora DB clusters only

" + "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,25 +2272,25 @@ "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": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. \n The default is not to copy them.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. \n The default is not to copy them.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "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
  • \n

    If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.

    \n
    • \n
  • \n

    If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

    \n
    • \n
\n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n
    \n
  • \n

    If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.

    \n
    • \n
  • \n

    If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.

    \n
    • \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
  • \n

    If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.

    \n
    • \n
  • \n

    If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

    \n
    • \n
\n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n
    \n
  • \n

    If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.

    \n
    • \n
  • \n

    If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.

    \n
    • \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

\n \n

The Multi-AZ DB clusters feature is in preview and is subject to change.

\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

    Must not match the name of an existing DB cluster parameter group.

    \n
    • \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

    Must not match the name of an existing DB cluster parameter group.

    \n
    • \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
    \n
  • \n

    \n aurora (for MySQL 5.6-compatible Aurora)

    \n
    • \n
  • \n

    \n aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)

    \n
    • \n
  • \n

    \n aurora-postgresql\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \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
    \n
  • \n

    \n aurora (for MySQL 5.6-compatible Aurora)

    \n
    • \n
  • \n

    \n aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)

    \n
    • \n
  • \n

    \n aurora-postgresql\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \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

\n \n

The Multi-AZ DB clusters feature is in preview and is subject to change.

\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
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \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
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \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
  • \n

    Must match the identifier of an existing DBCluster.

    \n
    • \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
  • \n

    Must match the identifier of an existing DBCluster.

    \n
    • \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

    Must contain 1 to 64 letters or numbers.

    \n
    • \n
  • \n

    Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

    \n
    • \n
  • \n

    Can't be a word reserved by the specified database engine

    \n
    • \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

    Must contain 1 to 64 letters or numbers.

    \n
    • \n
  • \n

    Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

    \n
    • \n
  • \n

    Can't be a word reserved by the specified database engine

    \n
    • \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

    Must contain 1 to 63 letters, numbers, or underscores.

    \n
    • \n
  • \n

    Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

    \n
    • \n
  • \n

    Can't be a word reserved by the specified database engine

    \n
    • \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

    Can't be longer than 8 characters

    \n
    • \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

    It must contain 1 to 8 alphanumeric characters.

    \n
    • \n
  • \n

    It must contain a letter.

    \n
    • \n
  • \n

    It can't be a word reserved by the database engine.

    \n
    • \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

    It must contain 1 to 64 alphanumeric characters.

    \n
    • \n
  • \n

    It can't be a word reserved by the database engine.

    \n
    • \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
    \n
  • \n

    It must contain 1 to 63 alphanumeric characters.

    \n
    • \n
  • \n

    It must begin with a letter or an underscore.\n Subsequent characters can be letters, underscores, or digits\n (0 to 9).

    \n
    • \n
  • \n

    It can't be a word reserved by the\n database engine.

    \n
    • \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

    Must contain 1 to 64 letters or numbers.

    \n
    • \n
  • \n

    Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

    \n
    • \n
  • \n

    Can't be a word reserved by the specified database engine

    \n
    • \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

    Must contain 1 to 64 letters or numbers.

    \n
    • \n
  • \n

    Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

    \n
    • \n
  • \n

    Can't be a word reserved by the specified database engine

    \n
    • \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

    Must contain 1 to 63 letters, numbers, or underscores.

    \n
    • \n
  • \n

    Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

    \n
    • \n
  • \n

    Can't be a word reserved by the specified database engine

    \n
    • \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

    Can't be longer than 8 characters

    \n
    • \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

    It must contain 1 to 8 alphanumeric characters.

    \n
    • \n
  • \n

    It must contain a letter.

    \n
    • \n
  • \n

    It can't be a word reserved by the database engine.

    \n
    • \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

    It must contain 1 to 64 alphanumeric characters.

    \n
    • \n
  • \n

    It can't be a word reserved by the database engine.

    \n
    • \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
    \n
  • \n

    It must contain 1 to 63 alphanumeric characters.

    \n
    • \n
  • \n

    It must begin with a letter or an underscore.\n Subsequent characters can be letters, underscores, or digits\n (0 to 9).

    \n
    • \n
  • \n

    It can't be a word reserved by the\n database engine.

    \n
    • \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
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \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
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \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

    General Purpose (SSD) storage (gp2): Must be an integer from 40 to 65536 for RDS Custom for Oracle, \n 16384 for RDS Custom for SQL Server.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 40 to 65536 for RDS Custom for Oracle, \n 16384 for RDS Custom for SQL Server.

    \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

    General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
    • \n
  • \n

    Magnetic storage (standard): Must be an integer from 5 to 3072.

    \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

    General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
    • \n
  • \n

    Magnetic storage (standard): Must be an integer from 5 to 3072.

    \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

    General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
    • \n
  • \n

    Magnetic storage (standard): Must be an integer from 5 to 3072.

    \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

    General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
    • \n
  • \n

    Magnetic storage (standard): Must be an integer from 10 to 3072.

    \n
    • \n
\n \n

\n SQL Server\n

\n

Constraints to the amount of storage for each storage type are the following:\n

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2):

    \n
      \n
    • \n

      Enterprise and Standard editions: Must be an integer from 20 to 16384.

      \n
      • \n
    • \n

      Web and Express editions: Must be an integer from 20 to 16384.

      \n
      • \n
    \n
    • \n
  • \n

    Provisioned IOPS storage (io1):

    \n
      \n
    • \n

      Enterprise and Standard editions: Must be an integer from 100 to 16384.

      \n
      • \n
    • \n

      Web and Express editions: Must be an integer from 100 to 16384.

      \n
      • \n
    \n
    • \n
  • \n

    Magnetic storage (standard):

    \n
      \n
    • \n

      Enterprise and Standard editions: Must be an integer from 20 to 1024.

      \n
      • \n
    • \n

      Web and Express editions: Must be an integer from 20 to 1024.

      \n
      • \n
    \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

    General Purpose (SSD) storage (gp2): Must be an integer from 40 to 65536 for RDS Custom for Oracle, \n 16384 for RDS Custom for SQL Server.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 40 to 65536 for RDS Custom for Oracle, \n 16384 for RDS Custom for SQL Server.

    \n
    • \n
\n

\n MySQL\n

\n

Constraints to the amount of storage for each storage type are the following:

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
    • \n
  • \n

    Magnetic storage (standard): Must be an integer from 5 to 3072.

    \n
    • \n
\n

\n MariaDB\n

\n

Constraints to the amount of storage for each storage type are the following:

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
    • \n
  • \n

    Magnetic storage (standard): Must be an integer from 5 to 3072.

    \n
    • \n
\n

\n PostgreSQL\n

\n

Constraints to the amount of storage for each storage type are the following:

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
    • \n
  • \n

    Magnetic storage (standard): Must be an integer from 5 to 3072.

    \n
    • \n
\n

\n Oracle\n

\n

Constraints to the amount of storage for each storage type are the following:

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
    • \n
  • \n

    Magnetic storage (standard): Must be an integer from 10 to 3072.

    \n
    • \n
\n

\n SQL Server\n

\n

Constraints to the amount of storage for each storage type are the following:

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2):

    \n
      \n
    • \n

      Enterprise and Standard editions: Must be an integer from 20 to 16384.

      \n
      • \n
    • \n

      Web and Express editions: Must be an integer from 20 to 16384.

      \n
      • \n
    \n
    • \n
  • \n

    Provisioned IOPS storage (io1):

    \n
      \n
    • \n

      Enterprise and Standard editions: Must be an integer from 100 to 16384.

      \n
      • \n
    • \n

      Web and Express editions: Must be an integer from 100 to 16384.

      \n
      • \n
    \n
    • \n
  • \n

    Magnetic storage (standard):

    \n
      \n
    • \n

      Enterprise and Standard editions: Must be an integer from 20 to 1024.

      \n
      • \n
    • \n

      Web and Express editions: Must be an integer from 20 to 1024.

      \n
      • \n
    \n
    • \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
    \n
  • \n

    \n aurora (for MySQL 5.6-compatible Aurora)

    \n
    • \n
  • \n

    \n aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)

    \n
    • \n
  • \n

    \n aurora-postgresql\n

    \n
    • \n
  • \n

    \n custom-oracle-ee (for RDS Custom for Oracle instances)\n

    \n
    • \n
  • \n

    \n custom-sqlserver-ee (for RDS Custom for SQL Server instances)\n

    \n
    • \n
  • \n

    \n custom-sqlserver-se (for RDS Custom for SQL Server instances)\n

    \n
    • \n
  • \n

    \n custom-sqlserver-web (for RDS Custom for SQL Server instances)\n

    \n
    • \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

    \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
    \n
  • \n

    \n aurora (for MySQL 5.6-compatible Aurora)

    \n
    • \n
  • \n

    \n aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)

    \n
    • \n
  • \n

    \n aurora-postgresql\n

    \n
    • \n
  • \n

    \n custom-oracle-ee (for RDS Custom for Oracle instances)\n

    \n
    • \n
  • \n

    \n custom-sqlserver-ee (for RDS Custom for SQL Server instances)\n

    \n
    • \n
  • \n

    \n custom-sqlserver-se (for RDS Custom for SQL Server instances)\n

    \n
    • \n
  • \n

    \n custom-sqlserver-web (for RDS Custom for SQL Server instances)\n

    \n
    • \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

    \n
    • \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
    \n
  • \n

    Required.

    \n
    • \n
  • \n

    Must be 1 to 16 letters, numbers, or underscores.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't be a reserved word for the chosen database engine.

    \n
    • \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
    \n
  • \n

    Required.

    \n
    • \n
  • \n

    Must be 1 to 16 letters, numbers, or underscores.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't be a reserved word for the chosen database engine.

    \n
    • \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
    \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \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
    \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \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
    \n
  • \n

    Must be a value from 0 to 35

    \n
    • \n
  • \n

    Can't be set to 0 if the DB instance is a source to read replicas

    \n
    • \n
  • \n

    Can't be set to 0 or 35 for an RDS Custom for Oracle DB instance

    \n
    • \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
    \n
  • \n

    Must be a value from 0 to 35

    \n
    • \n
  • \n

    Can't be set to 0 if the DB instance is a source to read replicas

    \n
    • \n
  • \n

    Can't be set to 0 or 35 for an RDS Custom for Oracle DB instance

    \n
    • \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
    \n
  • \n

    Must be in the format hh24:mi-hh24:mi.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred maintenance window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \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
    \n
  • \n

    Must be in the format hh24:mi-hh24:mi.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred maintenance window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \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
  • \n

    If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB instance is private.

    \n
    • \n
  • \n

    If the default VPC in the target Region has an internet gateway attached to it, the DB instance is public.

    \n
    • \n
\n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n
    \n
  • \n

    If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB instance is private.

    \n
    • \n
  • \n

    If the subnets are part of a VPC that has an internet gateway attached to it, the DB instance is public.

    \n
    • \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
  • \n

    If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB instance is private.

    \n
    • \n
  • \n

    If the default VPC in the target Region has an internet gateway attached to it, the DB instance is public.

    \n
    • \n
\n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n
    \n
  • \n

    If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB instance is private.

    \n
    • \n
  • \n

    If the subnets are part of a VPC that has an internet gateway attached to it, the DB instance is public.

    \n
    • \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
  • \n

    The profile must exist in your account.

    \n
    • \n
  • \n

    The profile must have an IAM role that Amazon EC2 has permissions to assume.

    \n
    • \n
  • \n

    The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    \n
    • \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
  • \n

    The profile must exist in your account.

    \n
    • \n
  • \n

    The profile must have an IAM role that Amazon EC2 has permissions to assume.

    \n
    • \n
  • \n

    The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    \n
    • \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
    \n
  • \n

    Must be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB\n instance.

    \n
    • \n
  • \n

    Can specify a DB instance that is a MySQL read replica only if the source is running MySQL\n 5.6 or later.

    \n
    • \n
  • \n

    For the limitations of Oracle read replicas, see Read Replica Limitations with Oracle in the\n Amazon RDS User Guide.

    \n
    • \n
  • \n

    For the limitations of SQL Server read replicas, see Read Replica\n Limitations with Microsoft SQL Server in the Amazon RDS User Guide.

    \n
    • \n
  • \n

    Can specify a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or\n later (9.4.7 and higher for cross-Region replication).

    \n
    • \n
  • \n

    The specified DB instance must have automatic backups enabled, that is, its backup\n retention period must be greater than 0.

    \n
    • \n
  • \n

    If the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB\n instance identifier.

    \n
    • \n
  • \n

    If the source DB instance is in a different Amazon Web Services Region from the read replica, specify a valid DB instance ARN. \n For more information, see Constructing an ARN for Amazon RDS \n in the Amazon RDS User Guide. This doesn't apply to SQL Server or RDS Custom, which don't support \n cross-Region replicas.

    \n
    • \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
    \n
  • \n

    Must be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB\n instance.

    \n
    • \n
  • \n

    Can specify a DB instance that is a MySQL read replica only if the source is running MySQL\n 5.6 or later.

    \n
    • \n
  • \n

    For the limitations of Oracle read replicas, see Read Replica Limitations with Oracle in the\n Amazon RDS User Guide.

    \n
    • \n
  • \n

    For the limitations of SQL Server read replicas, see Read Replica\n Limitations with Microsoft SQL Server in the Amazon RDS User Guide.

    \n
    • \n
  • \n

    Can specify a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or\n later (9.4.7 and higher for cross-Region replication).

    \n
    • \n
  • \n

    The specified DB instance must have automatic backups enabled, that is, its backup\n retention period must be greater than 0.

    \n
    • \n
  • \n

    If the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB\n instance identifier.

    \n
    • \n
  • \n

    If the source DB instance is in a different Amazon Web Services Region from the read replica, specify a valid DB instance ARN. \n For more information, see Constructing an ARN for Amazon RDS \n in the Amazon RDS User Guide. This doesn't apply to SQL Server or RDS Custom, which don't support \n cross-Region replicas.

    \n
    • \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
    \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \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
    \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \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
  • \n

    Can only be specified if the source DB instance identifier specifies a DB instance in another Amazon Web Services Region.

    \n
    • \n
  • \n

    If supplied, must match the name of an existing DBSubnetGroup.

    \n
    • \n
  • \n

    The specified DB subnet group must be in the same Amazon Web Services Region in which the operation is running.

    \n
    • \n
  • \n

    All read replicas in one Amazon Web Services Region that are created from the same source DB\n instance must either:>

    \n
      \n
    • \n

      Specify DB subnet groups from the same VPC. All these read replicas are created in the same\n VPC.

      \n
      • \n
    • \n

      Not specify a DB subnet group. All these read replicas are created outside of any\n VPC.

      \n
      • \n
    \n
    • \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
  • \n

    Can only be specified if the source DB instance identifier specifies a DB instance in another Amazon Web Services Region.

    \n
    • \n
  • \n

    If supplied, must match the name of an existing DBSubnetGroup.

    \n
    • \n
  • \n

    The specified DB subnet group must be in the same Amazon Web Services Region in which the operation is running.

    \n
    • \n
  • \n

    All read replicas in one Amazon Web Services Region that are created from the same source DB\n instance must either:>

    \n
      \n
    • \n

      Specify DB subnet groups from the same VPC. All these read replicas are created in the same\n VPC.

      \n
      • \n
    • \n

      Not specify a DB subnet group. All these read replicas are created outside of any\n VPC.

      \n
      • \n
    \n
    • \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

    \n DestinationRegion - The Amazon Web Services Region that the encrypted read\n replica is created in. This Amazon Web Services Region is the same one where the\n CreateDBInstanceReadReplica action is called that contains this presigned URL.

    \n \n

    For example, if you create an encrypted DB instance in the us-west-1 Amazon Web Services Region,\n from a source DB instance in the us-east-2 Amazon Web Services Region, \n then you call the CreateDBInstanceReadReplica action in\n the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the\n CreateDBInstanceReadReplica action in the us-west-2 Amazon Web Services Region. For this\n example, the DestinationRegion in the presigned URL must be set to\n the us-east-1 Amazon Web Services Region.\n

    \n
    • \n
  • \n

    \n KmsKeyId - The Amazon Web Services KMS key identifier for the key to use to\n encrypt the read replica in the destination Amazon Web Services Region. This is the same\n identifier for both the CreateDBInstanceReadReplica action that is\n called in the destination Amazon Web Services Region, and the action contained in the presigned\n URL.

    \n
    • \n
  • \n

    \n SourceDBInstanceIdentifier - The DB instance identifier for\n the encrypted DB instance to be replicated. This identifier must be in the\n Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you\n are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services\n Region, then your SourceDBInstanceIdentifier looks like the\n following example:\n arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.

    \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
  • \n

    \n DestinationRegion - The Amazon Web Services Region that the encrypted read\n replica is created in. This Amazon Web Services Region is the same one where the\n CreateDBInstanceReadReplica action is called that contains this presigned URL.

    \n

    For example, if you create an encrypted DB instance in the us-west-1 Amazon Web Services Region,\n from a source DB instance in the us-east-2 Amazon Web Services Region, \n then you call the CreateDBInstanceReadReplica action in\n the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the\n CreateDBInstanceReadReplica action in the us-west-2 Amazon Web Services Region. For this\n example, the DestinationRegion in the presigned URL must be set to\n the us-east-1 Amazon Web Services Region.

    \n
    • \n
  • \n

    \n KmsKeyId - The Amazon Web Services KMS key identifier for the key to use to\n encrypt the read replica in the destination Amazon Web Services Region. This is the same\n identifier for both the CreateDBInstanceReadReplica action that is\n called in the destination Amazon Web Services Region, and the action contained in the presigned\n URL.

    \n
    • \n
  • \n

    \n SourceDBInstanceIdentifier - The DB instance identifier for\n the encrypted DB instance to be replicated. This identifier must be in the\n Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you\n are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services\n Region, then your SourceDBInstanceIdentifier looks like the\n following example:\n arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.

    \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

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
  • \n

    The profile must exist in your account.

    \n
    • \n
  • \n

    The profile must have an IAM role that Amazon EC2 has permissions to assume.

    \n
    • \n
  • \n

    The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    \n
    • \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
  • \n

    The profile must exist in your account.

    \n
    • \n
  • \n

    The profile must have an IAM role that Amazon EC2 has permissions to assume.

    \n
    • \n
  • \n

    The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    \n
    • \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

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \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

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \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
    \n
  • \n

    \n aurora (for MySQL 5.6-compatible Aurora)

    \n
    • \n
  • \n

    \n aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)

    \n
    • \n
  • \n

    \n aurora-postgresql\n

    \n
    • \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

    \n
    • \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
    \n
  • \n

    \n aurora (for MySQL 5.6-compatible Aurora)

    \n
    • \n
  • \n

    \n aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)

    \n
    • \n
  • \n

    \n aurora-postgresql\n

    \n
    • \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

    \n
    • \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
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
  • \n

    Must not be \"Default\"

    \n
    • \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
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
  • \n

    Must not be \"Default\"

    \n
    • \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
  • \n

    Can't be null, empty, or blank

    \n
    • \n
  • \n

    Must contain from 1 to 255 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
\n

Example: my-snapshot-id\n

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

The identifier for the DB snapshot.

\n

Constraints:

\n
    \n
  • \n

    Can't be null, empty, or blank

    \n
    • \n
  • \n

    Must contain from 1 to 255 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \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
    \n
  • \n

    Must match the identifier of an existing DBInstance.

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

The identifier of the DB instance that you want to create the snapshot of.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DBInstance.

    \n
    • \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
  • \n

    Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens.

    \n
    • \n
  • \n

    Must not be default.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \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
  • \n

    Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens.

    \n
    • \n
  • \n

    Must not be default.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \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
    \n
  • \n

    If SourceIds are supplied, SourceType must also be provided.

    \n
    • \n
  • \n

    If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is an RDS Proxy, a DBProxyName value must be supplied.

    \n
    • \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
    \n
  • \n

    If SourceIds are supplied, SourceType must also be provided.

    \n
    • \n
  • \n

    If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is an RDS Proxy, a DBProxyName value must be supplied.

    \n
    • \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
  • \n

    Must be 1 to 255 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
\n

Example: myoptiongroup\n

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

Specifies the name of the option group to be created.

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \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
    \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

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

Specifies the name of the engine that this option group should be associated with.

\n

Valid Values:

\n
    \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

    \n
    • \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

\n \n

The Multi-AZ DB clusters feature is in preview and is subject to change.

\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
    \n
  • \n

    \n applying - The backtrack is currently being applied to or rolled back from the DB cluster.

    \n
    • \n
  • \n

    \n completed - The backtrack has successfully been applied to or rolled back from the DB cluster.

    \n
    • \n
  • \n

    \n failed - An error occurred while the backtrack was applied to or rolled back from the DB cluster.

    \n
    • \n
  • \n

    \n pending - The backtrack is currently pending application to or rollback from the DB cluster.

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

The status of the backtrack. This property returns one of the following\n values:

\n
    \n
  • \n

    \n applying - The backtrack is currently being applied to or rolled back from the DB cluster.

    \n
    • \n
  • \n

    \n completed - The backtrack has successfully been applied to or rolled back from the DB cluster.

    \n
    • \n
  • \n

    \n failed - An error occurred while the backtrack was applied to or rolled back from the DB cluster.

    \n
    • \n
  • \n

    \n pending - The backtrack is currently pending application to or rollback from the DB cluster.

    \n
    • \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
  • \n

    \n CreateDBClusterEndpoint\n

    \n
    • \n
  • \n

    \n DescribeDBClusterEndpoints\n

    \n
    • \n
  • \n

    \n ModifyDBClusterEndpoint\n

    \n
    • \n
  • \n

    \n DeleteDBClusterEndpoint\n

    \n
    • \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
  • \n

    \n CreateDBClusterEndpoint\n

    \n
    • \n
  • \n

    \n DescribeDBClusterEndpoints\n

    \n
    • \n
  • \n

    \n ModifyDBClusterEndpoint\n

    \n
    • \n
  • \n

    \n DeleteDBClusterEndpoint\n

    \n
    • \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

    Must be 1 to 255 letters or numbers.

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \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

    Must be 1 to 255 letters or numbers.

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \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
    \n
  • \n

    \n ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to\n access other Amazon Web Services on your behalf.

    \n
    • \n
  • \n

    \n PENDING - the IAM role ARN is being associated with the DB cluster.

    \n
    • \n
  • \n

    \n INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable\n to assume the IAM role in order to access other Amazon Web Services on your behalf.

    \n
    • \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
    \n
  • \n

    \n ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to\n access other Amazon Web Services on your behalf.

    \n
    • \n
  • \n

    \n PENDING - the IAM role ARN is being associated with the DB cluster.

    \n
    • \n
  • \n

    \n INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable\n to assume the IAM role in order to access other Amazon Web Services on your behalf.

    \n
    • \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
    \n
  • \n

    \n available\n

    \n
    • \n
  • \n

    \n copying\n

    \n
    • \n
  • \n

    \n creating\n

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

Specifies the status of this DB cluster snapshot. Valid statuses are the following:

\n
    \n
  • \n

    \n available\n

    \n
    • \n
  • \n

    \n copying\n

    \n
    • \n
  • \n

    \n creating\n

    \n
    • \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
    \n
  • \n

    For MySQL 5.6, minor version 5.6.34 or higher

    \n
    • \n
  • \n

    For MySQL 5.7, minor version 5.7.16 or higher

    \n
    • \n
  • \n

    Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.

    \n
    • \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
    \n
  • \n

    For MySQL 5.6, minor version 5.6.34 or higher

    \n
    • \n
  • \n

    For MySQL 5.7, minor version 5.7.16 or higher

    \n
    • \n
  • \n

    Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.

    \n
    • \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
  • \n

    The profile must exist in your account.

    \n
    • \n
  • \n

    The profile must have an IAM role that Amazon EC2 has permissions to assume.

    \n
    • \n
  • \n

    The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    \n
    • \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
  • \n

    The profile must exist in your account.

    \n
    • \n
  • \n

    The profile must have an IAM role that Amazon EC2 has permissions to assume.

    \n
    • \n
  • \n

    The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    \n
    • \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
    \n
  • \n

    \n active - automated backups for current instances

    \n
    • \n
  • \n

    \n retained - automated backups for deleted instances

    \n
    • \n
  • \n

    \n creating - automated backups that are waiting\n for the first automated snapshot to be available.

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

Provides a list of status information for an automated backup:

\n
    \n
  • \n

    \n active - automated backups for current instances

    \n
    • \n
  • \n

    \n retained - automated backups for deleted instances

    \n
    • \n
  • \n

    \n creating - automated backups that are waiting\n for the first automated snapshot to be available.

    \n
    • \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
    \n
  • \n

    \n ACTIVE - the IAM role ARN is associated with the DB instance and can be used to\n access other Amazon Web Services services on your behalf.

    \n
    • \n
  • \n

    \n PENDING - the IAM role ARN is being associated with the DB instance.

    \n
    • \n
  • \n

    \n INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable\n to assume the IAM role in order to access other Amazon Web Services services on your behalf.

    \n
    • \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
    \n
  • \n

    \n ACTIVE - the IAM role ARN is associated with the DB instance and can be used to\n access other Amazon Web Services services on your behalf.

    \n
    • \n
  • \n

    \n PENDING - the IAM role ARN is being associated with the DB instance.

    \n
    • \n
  • \n

    \n INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable\n to assume the IAM role in order to access other Amazon Web Services services on your behalf.

    \n
    • \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
    \n
  • \n

    \n CreateDBInstance\n

    \n
    • \n
  • \n

    \n CreateDBInstanceReadReplica\n

    \n
    • \n
  • \n

    \n DeleteDBInstance\n

    \n
    • \n
  • \n

    \n ModifyDBInstance\n

    \n
    • \n
  • \n

    \n RebootDBInstance\n

    \n
    • \n
  • \n

    \n RestoreDBInstanceFromDBSnapshot\n

    \n
    • \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
    \n
  • \n

    \n CreateDBInstance\n

    \n
    • \n
  • \n

    \n CreateDBInstanceReadReplica\n

    \n
    • \n
  • \n

    \n DeleteDBInstance\n

    \n
    • \n
  • \n

    \n ModifyDBInstance\n

    \n
    • \n
  • \n

    \n RebootDBInstance\n

    \n
    • \n
  • \n

    \n RestoreDBInstanceFromDBSnapshot\n

    \n
    • \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
    \n
  • \n

    \n ModifyDBInstance\n

    \n
    • \n
  • \n

    \n RebootDBInstance\n

    \n
    • \n
  • \n

    \n RestoreDBInstanceFromDBSnapshot\n

    \n
    • \n
  • \n

    \n RestoreDBInstanceToPointInTime\n

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

This data type is used as a response element in the following actions:

\n
    \n
  • \n

    \n ModifyDBInstance\n

    \n
    • \n
  • \n

    \n RebootDBInstance\n

    \n
    • \n
  • \n

    \n RestoreDBInstanceFromDBSnapshot\n

    \n
    • \n
  • \n

    \n RestoreDBInstanceToPointInTime\n

    \n
    • \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
  • \n

    The CEV must not be the default for RDS Custom. If it is, change the default \n before running this command.

    \n
    • \n
  • \n

    The CEV must not be associated with an RDS Custom DB instance, RDS Custom instance snapshot, \n or automated backup of your RDS Custom instance.

    \n
    • \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
  • \n

    The CEV must not be the default for RDS Custom. If it is, change the default \n before running this command.

    \n
    • \n
  • \n

    The CEV must not be associated with an RDS Custom DB instance, RDS Custom instance snapshot, \n or automated backup of your RDS Custom instance.

    \n
    • \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

\n \n

The Multi-AZ DB clusters feature is in preview and is subject to change.

\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
    \n
  • \n

    Must match an existing DBClusterIdentifier.

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

The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must match an existing DBClusterIdentifier.

    \n
    • \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
    \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \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
    \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \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

\n \n

The Multi-AZ DB clusters feature is in preview and is subject to change.

\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
    \n
  • \n

    Must be the name of an existing DB cluster parameter group.

    \n
    • \n
  • \n

    You can't delete a default DB cluster parameter group.

    \n
    • \n
  • \n

    Can't be associated with any DB clusters.

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

The name of the DB cluster parameter group.

\n

Constraints:

\n
    \n
  • \n

    Must be the name of an existing DB cluster parameter group.

    \n
    • \n
  • \n

    You can't delete a default DB cluster parameter group.

    \n
    • \n
  • \n

    Can't be associated with any DB clusters.

    \n
    • \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

\n \n

The Multi-AZ DB clusters feature is in preview and is subject to change.

\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
  • \n

    The DB cluster is a read replica of another Amazon Aurora DB cluster.

    \n
    • \n
  • \n

    The DB instance is the only instance in the DB cluster.

    \n
    • \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
  • \n

    The DB cluster is a read replica of another Amazon Aurora DB cluster.

    \n
    • \n
  • \n

    The DB instance is the only instance in the DB cluster.

    \n
    • \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
    \n
  • \n

    Must match the name of an existing DB instance.

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

The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must match the name of an existing DB instance.

    \n
    • \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
    \n
  • \n

    Must be 1 to 255 letters or numbers.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
  • \n

    Can't be specified when deleting a read replica.

    \n
    • \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
    \n
  • \n

    Must be 1 to 255 letters or numbers.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
  • \n

    Can't be specified when deleting a read replica.

    \n
    • \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
    \n
  • \n

    Must be the name of an existing DB parameter group

    \n
    • \n
  • \n

    You can't delete a default DB parameter group

    \n
    • \n
  • \n

    Can't be associated with any DB instances

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

The name of the DB parameter group.

\n

Constraints:

\n
    \n
  • \n

    Must be the name of an existing DB parameter group

    \n
    • \n
  • \n

    You can't delete a default DB parameter group

    \n
    • \n
  • \n

    Can't be associated with any DB instances

    \n
    • \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
    \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
  • \n

    Must not be \"Default\"

    \n
    • \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
    \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
  • \n

    Must not be \"Default\"

    \n
    • \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
    \n
  • \n

    Must match an existing CertificateIdentifier.

    \n
    • \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
    \n
  • \n

    Must match an existing CertificateIdentifier.

    \n
    • \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
  • \n

    Must contain from 1 to 63 alphanumeric characters or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \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
  • \n

    Must contain from 1 to 63 alphanumeric characters or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \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
    \n
  • \n

    \n db-cluster-backtrack-id - Accepts backtrack identifiers. The\n results list includes information about only the backtracks identified by these\n identifiers.

    \n
    • \n
  • \n

    \n db-cluster-backtrack-status - Accepts any of the following backtrack status values:

    \n
      \n
    • \n

      \n applying\n

      \n
      • \n
    • \n

      \n completed\n

      \n
      • \n
    • \n

      \n failed\n

      \n
      • \n
    • \n

      \n pending\n

      \n
      • \n
    \n

    The results list includes information about only the backtracks identified\n by these values.

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

A filter that specifies one or more DB clusters to describe. Supported filters\n include the following:

\n
    \n
  • \n

    \n db-cluster-backtrack-id - Accepts backtrack identifiers. The\n results list includes information about only the backtracks identified by these\n identifiers.

    \n
    • \n
  • \n

    \n db-cluster-backtrack-status - Accepts any of the following backtrack status values:

    \n
      \n
    • \n

      \n applying\n

      \n
      • \n
    • \n

      \n completed\n

      \n
      • \n
    • \n

      \n failed\n

      \n
      • \n
    • \n

      \n pending\n

      \n
      • \n
    \n

    The results list includes information about only the backtracks identified\n by these values.

    \n
    • \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

\n \n

The Multi-AZ DB clusters feature is in preview and is subject to change.

\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
    \n
  • \n

    If supplied, must match the name of an existing DBClusterParameterGroup.

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

The name of a specific DB cluster parameter group to return details for.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBClusterParameterGroup.

    \n
    • \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

\n \n

The Multi-AZ DB clusters feature is in preview and is subject to change.

\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
    \n
  • \n

    If supplied, must match the name of an existing DBClusterParameterGroup.

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

The name of a specific DB cluster parameter group to return parameter details for.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBClusterParameterGroup.

    \n
    • \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

\n \n

The Multi-AZ DB clusters feature is in preview and is subject to change.

\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
    \n
  • \n

    If supplied, must match the identifier of an existing DBCluster.

    \n
    • \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
    \n
  • \n

    If supplied, must match the identifier of an existing DBCluster.

    \n
    • \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
    \n
  • \n

    If supplied, must match the identifier of an existing DBClusterSnapshot.

    \n
    • \n
  • \n

    If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

    \n
    • \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
    \n
  • \n

    If supplied, must match the identifier of an existing DBClusterSnapshot.

    \n
    • \n
  • \n

    If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

    \n
    • \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
  • \n

    \n automated - Return all DB cluster snapshots that have been automatically taken by \n Amazon RDS for my Amazon Web Services account.

    \n
    • \n
  • \n

    \n manual - Return all DB cluster snapshots that have been taken by my Amazon Web Services account.

    \n
    • \n
  • \n

    \n shared - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account.

    \n
    • \n
  • \n

    \n public - Return all DB cluster snapshots that have been marked as public.

    \n
    • \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
  • \n

    \n automated - Return all DB cluster snapshots that have been automatically taken by \n Amazon RDS for my Amazon Web Services account.

    \n
    • \n
  • \n

    \n manual - Return all DB cluster snapshots that have been taken by my Amazon Web Services account.

    \n
    • \n
  • \n

    \n shared - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account.

    \n
    • \n
  • \n

    \n public - Return all DB cluster snapshots that have been marked as public.

    \n
    • \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
    \n
  • \n

    \n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs).

    \n
    • \n
  • \n

    \n db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers.

    \n
    • \n
  • \n

    \n snapshot-type - Accepts types of DB cluster snapshots.

    \n
    • \n
  • \n

    \n engine - Accepts names of database engines.

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

A filter that specifies one or more DB cluster snapshots to describe.

\n

Supported filters:

\n
    \n
  • \n

    \n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs).

    \n
    • \n
  • \n

    \n db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers.

    \n
    • \n
  • \n

    \n snapshot-type - Accepts types of DB cluster snapshots.

    \n
    • \n
  • \n

    \n engine - Accepts names of database engines.

    \n
    • \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 \n

The Multi-AZ DB clusters feature is in preview and is subject to change.

\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
    \n
  • \n

    If supplied, must match an existing DBClusterIdentifier.

    \n
    • \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
    \n
  • \n

    If supplied, must match an existing DBClusterIdentifier.

    \n
    • \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
    \n
  • \n

    \n clone-group-id - Accepts clone group identifiers. \n\t\t\t The results list only includes information about\n the DB clusters associated with these clone groups.

    \n
    • \n
  • \n

    \n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs). The results list only includes information about\n the DB clusters identified by these ARNs.

    \n
    • \n
  • \n

    \n domain - Accepts Active Directory directory IDs. \n The results list only includes information about\n the DB clusters associated with these domains.

    \n
    • \n
  • \n

    \n engine - Accepts engine names. \n The results list only includes information about\n the DB clusters for these engines.

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

A filter that specifies one or more DB clusters to describe.

\n

Supported filters:

\n
    \n
  • \n

    \n clone-group-id - Accepts clone group identifiers. \n The results list only includes information about\n the DB clusters associated with these clone groups.

    \n
    • \n
  • \n

    \n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs). The results list only includes information about\n the DB clusters identified by these ARNs.

    \n
    • \n
  • \n

    \n domain - Accepts Active Directory directory IDs. \n The results list only includes information about\n the DB clusters associated with these domains.

    \n
    • \n
  • \n

    \n engine - Accepts engine names. \n The results list only includes information about\n the DB clusters for these engines.

    \n
    • \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
    \n
  • \n

    \n aurora (for MySQL 5.6-compatible Aurora)

    \n
    • \n
  • \n

    \n aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)

    \n
    • \n
  • \n

    \n aurora-postgresql\n

    \n
    • \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

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

The database engine to return.

\n

Valid Values:

\n
    \n
  • \n

    \n aurora (for MySQL 5.6-compatible Aurora)

    \n
    • \n
  • \n

    \n aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)

    \n
    • \n
  • \n

    \n aurora-postgresql\n

    \n
    • \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

    \n
    • \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
    \n
  • \n

    If supplied, must match an existing DBParameterGroupFamily.

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

The name of a specific DB parameter group family to return details for.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match an existing DBParameterGroupFamily.

    \n
    • \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
    \n
  • \n

    \n db-parameter-group-family - Accepts parameter groups family names. \n The results list only includes information about\n the DB engine versions for these parameter group families.\n

    \n
    • \n
  • \n

    \n engine - Accepts engine names. \n The results list only includes information about\n the DB engine versions for these engines.\n

    \n
    • \n
  • \n

    \n engine-mode - Accepts DB engine modes. \n The results list only includes information about\n the DB engine versions for these engine modes. Valid \n DB engine modes are the following:\n

    \n
      \n
    • \n

      \n global\n

      \n
      • \n
    • \n

      \n multimaster\n

      \n
      • \n
    • \n

      \n parallelquery\n

      \n
      • \n
    • \n

      \n provisioned\n

      \n
      • \n
    • \n

      \n serverless\n

      \n
      • \n
    \n
    • \n
  • \n

    \n engine-version - Accepts engine versions. \n The results list only includes information about\n the DB engine versions for these engine versions.\n

    \n
    • \n
  • \n

    \n status - Accepts engine version statuses. \n The results list only includes information about\n the DB engine versions for these statuses. Valid statuses \n are the following:\n

    \n
      \n
    • \n

      \n available\n

      \n
      • \n
    • \n

      \n deprecated\n

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

A filter that specifies one or more DB engine versions to describe.

\n

Supported filters:

\n
    \n
  • \n

    \n db-parameter-group-family - Accepts parameter groups family names. \n The results list only includes information about\n the DB engine versions for these parameter group families.

    \n
    • \n
  • \n

    \n engine - Accepts engine names. \n The results list only includes information about\n the DB engine versions for these engines.

    \n
    • \n
  • \n

    \n engine-mode - Accepts DB engine modes. \n The results list only includes information about\n the DB engine versions for these engine modes. Valid \n DB engine modes are the following:

    \n
      \n
    • \n

      \n global\n

      \n
      • \n
    • \n

      \n multimaster\n

      \n
      • \n
    • \n

      \n parallelquery\n

      \n
      • \n
    • \n

      \n provisioned\n

      \n
      • \n
    • \n

      \n serverless\n

      \n
      • \n
    \n
    • \n
  • \n

    \n engine-version - Accepts engine versions. \n The results list only includes information about\n the DB engine versions for these engine versions.

    \n
    • \n
  • \n

    \n status - Accepts engine version statuses. \n The results list only includes information about\n the DB engine versions for these statuses. Valid statuses \n are the following:

    \n
      \n
    • \n

      \n available\n

      \n
      • \n
    • \n

      \n deprecated\n

      \n
      • \n
    \n
    • \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
  • \n\t\t\t\t

    \n\t\t\t\t\t status\n\t\t\t\t

    \n\t\t\t
      \n
    • \n

      \n active - automated backups for current instances

      \n
      • \n
    • \n

      \n retained - automated backups for deleted instances and after backup replication is stopped

      \n
      • \n
    • \n

      \n creating - automated backups that are waiting for the first automated snapshot to be available

      \n
      • \n
    \n\t\t\t
    • \n
  • \n

    \n\t\t db-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs). \n\t\t The results list includes only information about the DB instance automated backups identified by these ARNs.

    \n\t\t
    • \n
  • \n

    \n\t\t dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). \n\t\t The results list includes only information about the DB instance resources identified by these ARNs.

    \n\t\t
    • \n
\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
  • \n

    \n status\n

    \n
      \n
    • \n

      \n active - automated backups for current instances

      \n
      • \n
    • \n

      \n retained - automated backups for deleted instances and after backup replication is stopped

      \n
      • \n
    • \n

      \n creating - automated backups that are waiting for the first automated snapshot to be available

      \n
      • \n
    \n
    • \n
  • \n

    \n db-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs). \n The results list includes only information about the DB instance automated backups identified by these ARNs.

    \n
    • \n
  • \n

    \n dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). \n The results list includes only information about the DB instance resources identified by these ARNs.

    \n
    • \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", @@ -9659,25 +9659,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
    \n
  • \n

    If supplied, must match the identifier of an existing DBInstance.

    \n
    • \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
    \n
  • \n

    If supplied, must match the identifier of an existing DBInstance.

    \n
    • \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
    \n
  • \n

    \n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs). The results list only includes information about \n the DB instances associated with the DB clusters identified by these ARNs.

    \n
    • \n
  • \n

    \n db-instance-id - Accepts DB instance identifiers and DB \n instance Amazon Resource Names (ARNs). The results list only includes information about\n the DB instances identified by these ARNs.

    \n
    • \n
  • \n

    \n dbi-resource-id - Accepts DB instance resource identifiers. The results list will \n only include information about the DB instances identified by these DB instance resource identifiers.

    \n
    • \n
  • \n

    \n domain - Accepts Active Directory directory IDs. The results list only includes \n information about the DB instances associated with these domains.

    \n
    • \n
  • \n

    \n engine - Accepts engine names. The results list only includes information \n about the DB instances for these engines.

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

A filter that specifies one or more DB instances to describe.

\n

Supported filters:

\n
    \n
  • \n

    \n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs). The results list only includes information about \n the DB instances associated with the DB clusters identified by these ARNs.

    \n
    • \n
  • \n

    \n db-instance-id - Accepts DB instance identifiers and DB \n instance Amazon Resource Names (ARNs). The results list only includes information about\n the DB instances identified by these ARNs.

    \n
    • \n
  • \n

    \n dbi-resource-id - Accepts DB instance resource identifiers. The results list will \n only include information about the DB instances identified by these DB instance resource identifiers.

    \n
    • \n
  • \n

    \n domain - Accepts Active Directory directory IDs. The results list only includes \n information about the DB instances associated with these domains.

    \n
    • \n
  • \n

    \n engine - Accepts engine names. The results list only includes information \n about the DB instances for these engines.

    \n
    • \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.

" } } }, @@ -9699,7 +9699,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", @@ -9749,7 +9749,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
    \n
  • \n

    Must match the identifier of an existing DBInstance.

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

The customer-assigned name of the DB instance that contains the log files you want to list.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DBInstance.

    \n
    • \n
", "smithy.api#required": {} } }, @@ -9806,12 +9806,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": { @@ -9828,7 +9828,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", @@ -9843,7 +9843,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
    \n
  • \n

    If supplied, must match the name of an existing DBClusterParameterGroup.

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

The name of a specific DB parameter group to return details for.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBClusterParameterGroup.

    \n
    • \n
" } }, "Filters": { @@ -9855,13 +9855,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.

" } } }, @@ -9898,14 +9898,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
    \n
  • \n

    If supplied, must match the name of an existing DBParameterGroup.

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

The name of a specific DB parameter group to return details for.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBParameterGroup.

    \n
    • \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": { @@ -9917,13 +9917,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.

" } } } @@ -9969,13 +9969,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.

" } } } @@ -9992,7 +9992,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.

" } } } @@ -10047,13 +10047,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.

" } } } @@ -10070,7 +10070,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.

" } } } @@ -10129,13 +10129,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.

" } } } @@ -10152,7 +10152,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.

" } } } @@ -10214,13 +10214,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.

" } } } @@ -10237,7 +10237,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.

" } } } @@ -10256,7 +10256,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", @@ -10283,13 +10283,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.

" } } }, @@ -10311,7 +10311,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": { @@ -10497,49 +10497,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
    \n
  • \n

    If supplied, must match the identifier of an existing DBInstance.

    \n
    • \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
    \n
  • \n

    If supplied, must match the identifier of an existing DBInstance.

    \n
    • \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
    \n
  • \n

    If supplied, must match the identifier of an existing DBSnapshot.

    \n
    • \n
  • \n

    If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

    \n
    • \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
    \n
  • \n

    If supplied, must match the identifier of an existing DBSnapshot.

    \n
    • \n
  • \n

    If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

    \n
    • \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
  • \n

    \n automated - Return all DB snapshots that have been automatically taken by \n Amazon RDS for my Amazon Web Services account.

    \n
    • \n
  • \n

    \n manual - Return all DB snapshots that have been taken by my Amazon Web Services account.

    \n
    • \n
  • \n

    \n shared - Return all manual DB snapshots that have been shared to my Amazon Web Services account.

    \n
    • \n
  • \n

    \n public - Return all DB snapshots that have been marked as public.

    \n
    • \n
  • \n

    \n awsbackup - Return the DB snapshots managed by the Amazon Web Services Backup service.

    \n

    For information about Amazon Web Services Backup, see the \n \n Amazon Web Services Backup Developer Guide.\n \n

    \n

    The awsbackup type does not apply to Aurora.

    \n
    • \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
  • \n

    \n automated - Return all DB snapshots that have been automatically taken by \n Amazon RDS for my Amazon Web Services account.

    \n
    • \n
  • \n

    \n manual - Return all DB snapshots that have been taken by my Amazon Web Services account.

    \n
    • \n
  • \n

    \n shared - Return all manual DB snapshots that have been shared to my Amazon Web Services account.

    \n
    • \n
  • \n

    \n public - Return all DB snapshots that have been marked as public.

    \n
    • \n
  • \n

    \n awsbackup - Return the DB snapshots managed by the Amazon Web Services Backup service.

    \n

    For information about Amazon Web Services Backup, see the \n \n Amazon Web Services Backup Developer Guide.\n \n

    \n

    The awsbackup type does not apply to Aurora.

    \n
    • \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
    \n
  • \n

    \n db-instance-id - Accepts DB instance identifiers and DB \n instance Amazon Resource Names (ARNs).

    \n
    • \n
  • \n

    \n db-snapshot-id - Accepts DB snapshot identifiers.

    \n
    • \n
  • \n

    \n dbi-resource-id - Accepts identifiers of source DB instances.

    \n
    • \n
  • \n

    \n snapshot-type - Accepts types of DB snapshots.

    \n
    • \n
  • \n

    \n engine - Accepts names of database engines.

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

A filter that specifies one or more DB snapshots to describe.

\n

Supported filters:

\n
    \n
  • \n

    \n db-instance-id - Accepts DB instance identifiers and DB \n instance Amazon Resource Names (ARNs).

    \n
    • \n
  • \n

    \n db-snapshot-id - Accepts DB snapshot identifiers.

    \n
    • \n
  • \n

    \n dbi-resource-id - Accepts identifiers of source DB instances.

    \n
    • \n
  • \n

    \n snapshot-type - Accepts types of DB snapshots.

    \n
    • \n
  • \n

    \n engine - Accepts names of database engines.

    \n
    • \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": { @@ -10567,7 +10567,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", @@ -10594,13 +10594,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.

" } } }, @@ -10617,7 +10617,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": { @@ -10639,13 +10639,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.

" } } }, @@ -10698,13 +10698,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.

" } } }, @@ -10729,7 +10729,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": { @@ -10738,7 +10738,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": { @@ -10766,7 +10766,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", @@ -10793,13 +10793,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 .

" } } }, @@ -10816,7 +10816,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", @@ -10831,7 +10831,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
    \n
  • \n

    If SourceIdentifier is supplied, SourceType must also be provided.

    \n
    • \n
  • \n

    If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is an RDS Proxy, a DBProxyName value must be supplied.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \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
    \n
  • \n

    If SourceIdentifier is supplied, SourceType must also be provided.

    \n
    • \n
  • \n

    If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is an RDS Proxy, a DBProxyName value must be supplied.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
" } }, "SourceType": { @@ -10843,19 +10843,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": { @@ -10873,13 +10873,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.

" } } }, @@ -10901,7 +10901,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", @@ -10928,19 +10928,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
    \n
  • \n

    \n export-task-identifier - An identifier for the snapshot export task.

    \n
    • \n
  • \n

    \n s3-bucket - The Amazon S3 bucket the snapshot is exported to.

    \n
    • \n
  • \n

    \n source-arn - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3

    \n
    • \n
  • \n

    \n status - The status of the export task. Must be lowercase. Valid statuses are the following:

    \n
      \n
    • \n

      \n canceled\n

      \n
      • \n
    • \n

      \n canceling\n

      \n
      • \n
    • \n

      \n complete\n

      \n
      • \n
    • \n

      \n failed\n

      \n
      • \n
    • \n

      \n in_progress\n

      \n
      • \n
    • \n

      \n starting\n

      \n
      • \n
    \n
    • \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
    \n
  • \n

    \n export-task-identifier - An identifier for the snapshot export task.

    \n
    • \n
  • \n

    \n s3-bucket - The Amazon S3 bucket the snapshot is exported to.

    \n
    • \n
  • \n

    \n source-arn - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3

    \n
    • \n
  • \n

    \n status - The status of the export task. Must be lowercase. Valid statuses are the following:

    \n
      \n
    • \n

      \n canceled\n

      \n
      • \n
    • \n

      \n canceling\n

      \n
      • \n
    • \n

      \n complete\n

      \n
      • \n
    • \n

      \n failed\n

      \n
      • \n
    • \n

      \n in_progress\n

      \n
      • \n
    • \n

      \n starting\n

      \n
      • \n
    \n
    • \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.

" } } } @@ -10959,7 +10959,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", @@ -10974,7 +10974,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
    \n
  • \n

    If supplied, must match an existing DBClusterIdentifier.

    \n
    • \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
    \n
  • \n

    If supplied, must match an existing DBClusterIdentifier.

    \n
    • \n
" } }, "Filters": { @@ -10986,13 +10986,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.

" } } } @@ -11032,7 +11032,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
    \n
  • \n

    \n custom-availability-zone-id - Accepts custom Availability Zone (AZ)\n identifiers. The results list includes information about only the custom AZs\n identified by these identifiers.

    \n
    • \n
  • \n

    \n engine - Accepts database engines. The results list includes information about \n only the database engines identified by these identifiers.

    \n

    For more information about the valid engines for installation media, see ImportInstallationMedia.

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

A filter that specifies one or more installation media to describe. Supported filters\n include the following:

\n
    \n
  • \n

    \n custom-availability-zone-id - Accepts custom Availability Zone (AZ)\n identifiers. The results list includes information about only the custom AZs\n identified by these identifiers.

    \n
    • \n
  • \n

    \n engine - Accepts database engines. The results list includes information about \n only the database engines identified by these identifiers.

    \n

    For more information about the valid engines for installation media, see ImportInstallationMedia.

    \n
    • \n
" } }, "MaxRecords": { @@ -11073,7 +11073,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
    \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

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

A required parameter. Options available for the given engine name are described.

\n

Valid Values:

\n
    \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

    \n
    • \n
", "smithy.api#required": {} } }, @@ -11092,7 +11092,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": { @@ -11147,19 +11147,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
    \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

    \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
    \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

    \n
    • \n
" } }, "MajorEngineVersion": { @@ -11197,7 +11197,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
    \n
  • \n

    \n aurora (for MySQL 5.6-compatible Aurora)

    \n
    • \n
  • \n

    \n aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)

    \n
    • \n
  • \n

    \n aurora-postgresql\n

    \n
    • \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

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

The name of the engine to retrieve DB instance options for.

\n

Valid Values:

\n
    \n
  • \n

    \n aurora (for MySQL 5.6-compatible Aurora)

    \n
    • \n
  • \n

    \n aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)

    \n
    • \n
  • \n

    \n aurora-postgresql\n

    \n
    • \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

    \n
    • \n
", "smithy.api#required": {} } }, @@ -11216,19 +11216,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": { @@ -11240,13 +11240,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.

" } } }, @@ -11289,19 +11289,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
    \n
  • \n

    \n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs). The results list only includes pending maintenance \n actions for the DB clusters identified by these ARNs.

    \n
    • \n
  • \n

    \n db-instance-id - Accepts DB instance identifiers and DB \n instance ARNs. The results list only includes pending maintenance \n actions for the DB instances identified by these ARNs.

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

A filter that specifies one or more resources to return pending maintenance actions for.

\n

Supported filters:

\n
    \n
  • \n

    \n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs). The results list only includes pending maintenance \n actions for the DB clusters identified by these ARNs.

    \n
    • \n
  • \n

    \n db-instance-id - Accepts DB instance identifiers and DB \n instance ARNs. The results list only includes pending maintenance \n actions for the DB instances identified by these ARNs.

    \n
    • \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.

" } } }, @@ -11356,7 +11356,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": { @@ -11368,7 +11368,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": { @@ -11380,7 +11380,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": { @@ -11392,13 +11392,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.

" } } }, @@ -11435,7 +11435,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": { @@ -11447,19 +11447,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": { @@ -11477,13 +11477,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.

" } } }, @@ -11521,7 +11521,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": { @@ -11558,7 +11558,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": { @@ -11567,7 +11567,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": {} } } @@ -11633,9 +11633,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": { @@ -11650,7 +11647,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 } @@ -11710,7 +11707,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", @@ -11730,7 +11727,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": { @@ -11750,7 +11747,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
    \n
  • \n

    Must match the identifier of an existing DBInstance.

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

The customer-assigned name of the DB instance that contains the log files you want to list.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DBInstance.

    \n
    • \n
", "smithy.api#required": {} } }, @@ -11770,7 +11767,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
    \n
  • \n

    If neither Marker or NumberOfLines are specified, the entire log file is returned up to a \n maximum of 10000 lines, starting with the most recent log entries first.

    \n
    • \n
  • \n

    If \n NumberOfLines is specified and Marker isn't specified, then the most recent lines from the end \n of the log file are returned.

    \n
    • \n
  • \n

    If Marker is specified as \"0\", then the specified \n number of lines from the beginning of the log file are returned.

    \n
    • \n
  • \n

    You can \n download the log file in blocks of lines by specifying the size of the block using \n the NumberOfLines parameter, and by specifying a value of \"0\" for the Marker parameter in your \n first request. Include the Marker value returned in the response as the Marker value for the next \n request, continuing until the AdditionalDataPending response element returns false.

    \n
    • \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
    \n
  • \n

    If neither Marker or NumberOfLines are specified, the entire log file is returned up to a \n maximum of 10000 lines, starting with the most recent log entries first.

    \n
    • \n
  • \n

    If \n NumberOfLines is specified and Marker isn't specified, then the most recent lines from the end \n of the log file are returned.

    \n
    • \n
  • \n

    If Marker is specified as \"0\", then the specified \n number of lines from the beginning of the log file are returned.

    \n
    • \n
  • \n

    You can \n download the log file in blocks of lines by specifying the size of the block using \n the NumberOfLines parameter, and by specifying a value of \"0\" for the Marker parameter in your \n first request. Include the Marker value returned in the response as the Marker value for the next \n request, continuing until the AdditionalDataPending response element returns false.

    \n
    • \n
" } } }, @@ -11802,12 +11799,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
    \n
  • \n

    \n AuthorizeDBSecurityGroupIngress\n

    \n
    • \n
  • \n

    \n DescribeDBSecurityGroups\n

    \n
    • \n
  • \n

    \n RevokeDBSecurityGroupIngress\n

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

This data type is used as a response element in the following actions:

\n
    \n
  • \n

    \n AuthorizeDBSecurityGroupIngress\n

    \n
    • \n
  • \n

    \n DescribeDBSecurityGroups\n

    \n
    • \n
  • \n

    \n RevokeDBSecurityGroupIngress\n

    \n
    • \n
" } }, "com.amazonaws.rds#EC2SecurityGroupList": { @@ -11842,7 +11839,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
  • \n

    \n CreateDBInstance\n

    \n
    • \n
  • \n

    \n DescribeDBInstances\n

    \n
    • \n
  • \n

    \n DeleteDBInstance\n

    \n
    • \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
  • \n

    \n CreateDBInstance\n

    \n
    • \n
  • \n

    \n DescribeDBInstances\n

    \n
    • \n
  • \n

    \n DeleteDBInstance\n

    \n
    • \n
\n

For the data structure that represents Amazon Aurora DB cluster endpoints,\n see DBClusterEndpoint.

" } }, "com.amazonaws.rds#EngineDefaults": { @@ -11857,7 +11854,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": { @@ -11868,7 +11865,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": { @@ -11933,7 +11930,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": { @@ -11980,7 +11977,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.

" } } }, @@ -12021,7 +12018,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": { @@ -12097,7 +12094,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": { @@ -12117,18 +12114,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": { @@ -12140,7 +12137,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": { @@ -12152,7 +12149,7 @@ "ExportOnly": { "target": "com.amazonaws.rds#StringList", "traits": { - "smithy.api#documentation": "

The data exported from the snapshot. Valid values are the following:

\n
    \n
  • \n

    \n database - Export all the data from a specified database.

    \n
    • \n
  • \n

    \n database.table \n table-name - \n Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.

    \n
    • \n
  • \n

    \n database.schema \n schema-name - Export a database schema of the snapshot. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

    \n
    • \n
  • \n

    \n database.schema.table \n table-name - Export a table of the database schema. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

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

The data exported from the snapshot. Valid values are the following:

\n
    \n
  • \n

    \n database - Export all the data from a specified database.

    \n
    • \n
  • \n

    \n database.table\n table-name - \n Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.

    \n
    • \n
  • \n

    \n database.schema\n schema-name - Export a database schema of the snapshot. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

    \n
    • \n
  • \n

    \n database.schema.table\n table-name - Export a table of the database schema. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

    \n
    • \n
" } }, "SnapshotTime": { @@ -12188,13 +12185,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": { @@ -12229,7 +12226,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": { @@ -12312,7 +12309,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

\n \n

The Multi-AZ DB clusters feature is in preview and is subject to change.

\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": { @@ -12321,7 +12318,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
    \n
  • \n

    Must match the identifier of an existing DBCluster.

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

A DB cluster identifier to force a failover for. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DBCluster.

    \n
    • \n
", "smithy.api#required": {} } }, @@ -12367,7 +12364,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": { @@ -12376,14 +12373,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
    \n
  • \n

    Must match the identifier of an existing\n GlobalCluster (Aurora global database).

    \n
    • \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
    \n
  • \n

    Must match the identifier of an existing\n GlobalCluster (Aurora global database).

    \n
    • \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": {} } } @@ -12403,13 +12400,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
    \n
  • \n

    pending – A request to fail over the Aurora global database (GlobalCluster) has been received by the service. The\n GlobalCluster's primary DB cluster and the specified secondary DB cluster are being verified before the failover\n process can start.

    \n
    • \n
  • \n

    failing-over – This status covers the range of Aurora internal operations that take place during the failover process, such\n as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB, and synchronizing replicas.

    \n
    • \n
  • \n

    cancelling – The request to fail over the Aurora global database (GlobalCluster) was cancelled and the primary\n Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states. \n

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

The current status of the Aurora global database (GlobalCluster). Possible values are as follows:

\n
    \n
  • \n

    pending – A request to fail over the Aurora global database (GlobalCluster) has been received by the service. The\n GlobalCluster's primary DB cluster and the specified secondary DB cluster are being verified before the failover\n process can start.

    \n
    • \n
  • \n

    failing-over – This status covers the range of Aurora internal operations that take place during the failover process, such\n as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB, and synchronizing replicas.

    \n
    • \n
  • \n

    cancelling – The request to fail over the Aurora global database (GlobalCluster) was cancelled and the primary\n Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.

    \n
    • \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": { @@ -12420,7 +12417,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": { @@ -12467,7 +12464,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
    \n
  • \n

    \n DescribeDBClusterBacktracks\n

    \n
    • \n
  • \n

    \n DescribeDBClusterEndpoints\n

    \n
    • \n
  • \n

    \n DescribeDBClusters\n

    \n
    • \n
  • \n

    \n DescribeDBInstances\n

    \n
    • \n
  • \n

    \n DescribePendingMaintenanceActions\n

    \n
    • \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
    \n
  • \n

    \n DescribeDBClusterBacktracks\n

    \n
    • \n
  • \n

    \n DescribeDBClusterEndpoints\n

    \n
    • \n
  • \n

    \n DescribeDBClusters\n

    \n
    • \n
  • \n

    \n DescribeDBInstances\n

    \n
    • \n
  • \n

    \n DescribePendingMaintenanceActions\n

    \n
    • \n
" } }, "com.amazonaws.rds#FilterList": { @@ -12494,13 +12491,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": { @@ -12518,7 +12515,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": { @@ -12530,31 +12527,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).

" } } }, @@ -12604,19 +12601,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": { @@ -12627,7 +12624,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": { @@ -12651,7 +12648,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 } @@ -12679,13 +12676,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.

" } } } @@ -12722,7 +12719,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": { @@ -12801,21 +12798,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
    \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

    \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
    \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

    \n
    • \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": {} } }, @@ -13149,7 +13146,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 } @@ -13302,7 +13299,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 } @@ -13387,7 +13384,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 } @@ -13404,7 +13401,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 } @@ -13536,7 +13533,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": { @@ -13628,7 +13625,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
  • \n

    You already migrated your applications to support the latest certificate authority (CA) certificate, but the new CA certificate is not yet \n the RDS default CA certificate for the specified Amazon Web Services Region.

    \n
    • \n
  • \n

    RDS has already moved to a new default CA certificate for the specified Amazon Web Services\n Region, but you are still in the process of supporting the new CA certificate.\n In this case, you temporarily need additional time to finish your application\n changes.

    \n
    • \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
  • \n

    You already migrated your applications to support the latest certificate authority (CA) certificate, but the new CA certificate is not yet \n the RDS default CA certificate for the specified Amazon Web Services Region.

    \n
    • \n
  • \n

    RDS has already moved to a new default CA certificate for the specified Amazon Web Services\n Region, but you are still in the process of supporting the new CA certificate.\n In this case, you temporarily need additional time to finish your application\n changes.

    \n
    • \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": { @@ -13637,7 +13634,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": { @@ -13676,7 +13673,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": { @@ -13692,13 +13689,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
    \n
  • \n

    For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

    \n
    • \n
  • \n

    For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

    \n
    • \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
    \n
  • \n

    For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

    \n
    • \n
  • \n

    For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

    \n
    • \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": { @@ -13726,7 +13723,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": { @@ -13755,7 +13752,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.

" } } } @@ -13807,7 +13804,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

\n \n

The Multi-AZ DB clusters feature is in preview and is subject to change.

\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": { @@ -13836,7 +13833,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": { @@ -13875,86 +13872,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
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens

    \n
    • \n
  • \n

    The first character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \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
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens

    \n
    • \n
  • \n

    The first character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \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
  • \n

    Must be a value from 1 to 35

    \n
    • \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
  • \n

    Must be a value from 1 to 35

    \n
    • \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
  • \n

    Must be in the format hh24:mi-hh24:mi.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred maintenance window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \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
  • \n

    Must be in the format hh24:mi-hh24:mi.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred maintenance window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \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
  • \n

    If specified, this value must be set to a number from 0 to 259,200 (72 hours).

    \n
    • \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
  • \n

    If specified, this value must be set to a number from 0 to 259,200 (72 hours).

    \n
    • \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.

\n

Valid for: Aurora DB clusters only

" + "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": { @@ -13966,19 +13963,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
  • \n

    The DB parameter group must be in the same DB parameter group family as this DB cluster.

    \n
    • \n
  • \n

    The DBInstanceParameterGroupName parameter is valid in combination with the\n AllowMajorVersionUpgrade parameter for a major version upgrade only.

    \n
    • \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
  • \n

    The DB parameter group must be in the same DB parameter group family as this DB cluster.

    \n
    • \n
  • \n

    The DBInstanceParameterGroupName parameter is valid in combination with the\n AllowMajorVersionUpgrade parameter for a major version upgrade only.

    \n
    • \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": { @@ -13996,49 +13993,49 @@ "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": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. \n The default is not to copy them.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. \n The default is not to copy them.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "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": { @@ -14050,7 +14047,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": { @@ -14062,7 +14059,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": { @@ -14099,7 +14096,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

\n \n

The Multi-AZ DB clusters feature is in preview and is subject to change.

\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": { @@ -14115,7 +14112,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": {} } } @@ -14265,7 +14262,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": { @@ -14274,98 +14271,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
    \n
  • \n

    Must match the identifier of an existing DBInstance.

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

The DB instance identifier. This value is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DBInstance.

    \n
    • \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
    \n
  • \n

    If supplied, must match existing DBSecurityGroups.

    \n
    • \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
    \n
  • \n

    If supplied, must match existing DBSecurityGroups.

    \n
    • \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
    \n
  • \n

    If supplied, must match existing VpcSecurityGroupIds.

    \n
    • \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
    \n
  • \n

    If supplied, must match existing VpcSecurityGroupIds.

    \n
    • \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
    \n
  • \n

    It must be a value from 0 to 35. It can't be set to 0 if the DB instance is a source to \n read replicas. It can't be set to 0 or 35 for an RDS Custom for Oracle DB instance.

    \n
    • \n
  • \n

    It can be specified for a MySQL read replica only if the source is running MySQL 5.6 or\n later.

    \n
    • \n
  • \n

    It can be specified for a PostgreSQL read replica only if the source is running PostgreSQL\n 9.3.5.

    \n
    • \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
    \n
  • \n

    It must be a value from 0 to 35. It can't be set to 0 if the DB instance is a source to \n read replicas. It can't be set to 0 or 35 for an RDS Custom for Oracle DB instance.

    \n
    • \n
  • \n

    It can be specified for a MySQL read replica only if the source is running MySQL 5.6 or\n later.

    \n
    • \n
  • \n

    It can be specified for a PostgreSQL read replica only if the source is running PostgreSQL\n 9.3.5.

    \n
    • \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
    \n
  • \n

    Must be in the format hh24:mi-hh24:mi

    \n
    • \n
  • \n

    Must be in Universal Time Coordinated (UTC)

    \n
    • \n
  • \n

    Must not conflict with the preferred maintenance window

    \n
    • \n
  • \n

    Must be at least 30 minutes

    \n
    • \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
    \n
  • \n

    Must be in the format hh24:mi-hh24:mi

    \n
    • \n
  • \n

    Must be in Universal Time Coordinated (UTC)

    \n
    • \n
  • \n

    Must not conflict with the preferred maintenance window

    \n
    • \n
  • \n

    Must be at least 30 minutes

    \n
    • \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
  • \n

    The automatic upgrade is enabled for the maintenance window.

    \n
    • \n
  • \n

    A newer minor version is available.

    \n
    • \n
  • \n

    RDS has enabled automatic patching for the engine version.

    \n
    • \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
  • \n

    The automatic upgrade is enabled for the maintenance window.

    \n
    • \n
  • \n

    A newer minor version is available.

    \n
    • \n
  • \n

    RDS has enabled automatic patching for the engine version.

    \n
    • \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": { @@ -14377,103 +14374,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
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    The first character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \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
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    The first character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \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": { @@ -14509,7 +14506,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": { @@ -14521,7 +14518,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": { @@ -14551,7 +14548,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.

" } } }, @@ -14584,7 +14581,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": { @@ -14593,14 +14590,14 @@ "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the DB parameter group.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBParameterGroup.

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

The name of the DB parameter group.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBParameterGroup.

    \n
    • \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": {} } } @@ -14837,7 +14834,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": { @@ -14860,7 +14857,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": { @@ -14876,20 +14873,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.

" } } }, @@ -14918,13 +14915,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 5.5.46 (supported for 5.1 DB snapshots)

    \n
    • \n
\n \n \n

\n Oracle\n

\n \n
    \n
  • \n

    \n 12.1.0.2.v8 (supported for 12.1.0.1 DB snapshots)

    \n
    • \n
  • \n

    \n 11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots)

    \n
    • \n
  • \n

    \n 11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots)

    \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

    \n 5.5.46 (supported for 5.1 DB snapshots)

    \n
    • \n
\n

\n Oracle\n

\n
    \n
  • \n

    \n 12.1.0.2.v8 (supported for 12.1.0.1 DB snapshots)

    \n
    • \n
  • \n

    \n 11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots)

    \n
    • \n
  • \n

    \n 11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots)

    \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

" } } } @@ -14972,7 +14969,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": {} } }, @@ -15031,7 +15028,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": { @@ -15053,19 +15050,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.

" } } }, @@ -15104,7 +15101,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": { @@ -15113,31 +15110,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
    \n
  • \n

    Must match the identifier of an existing global database cluster.

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

The DB cluster identifier for the global cluster being modified. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing global database cluster.

    \n
    • \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
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens

    \n
    • \n
  • \n

    The first character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \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
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens

    \n
    • \n
  • \n

    The first character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \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.

" } } } @@ -15176,7 +15173,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": {} } }, @@ -15363,13 +15360,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": { @@ -15412,7 +15409,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.

" } } }, @@ -15518,19 +15515,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": { @@ -15682,7 +15679,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.

" } } }, @@ -16006,12 +16003,12 @@ "SupportsClusters": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

Whether DB instances can be configured as a Multi-AZ DB cluster.

\n

The Multi-AZ DB clusters feature is in preview and is subject to change.

\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": "

Whether DB instances can be configured as a 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 Amazon RDS User Guide.\n

" } } }, "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": { @@ -16035,12 +16032,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": { @@ -16054,7 +16051,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": { @@ -16105,7 +16102,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": { @@ -16128,7 +16125,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": { @@ -16178,7 +16175,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": { @@ -16234,7 +16231,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.

" } } }, @@ -16347,12 +16344,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": { @@ -16367,7 +16364,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 } @@ -16389,7 +16386,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
  • \n

    \n CreateDBInstance\n

    \n
    • \n
  • \n

    \n ModifyDBInstance\n

    \n
    • \n
  • \n

    \n RestoreDBInstanceFromDBSnapshot\n

    \n
    • \n
  • \n

    \n RestoreDBInstanceFromS3\n

    \n
    • \n
  • \n

    \n RestoreDBInstanceToPointInTime\n

    \n
    • \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
  • \n

    \n DescribeDBInstances\n

    \n
    • \n
  • \n

    \n DescribeDBSnapshots\n

    \n
    • \n
  • \n

    \n DescribeValidDBInstanceModifications\n

    \n
    • \n
\n

If you call DescribeDBInstances, ProcessorFeature returns\n non-null values only if the following conditions are met:

\n
    \n
  • \n

    You are accessing an Oracle DB instance.

    \n
    • \n
  • \n

    Your Oracle DB instance class supports configuring the number of CPU cores and threads per core.

    \n
    • \n
  • \n

    The current number CPU cores and threads is set to a non-default value.

    \n
    • \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
  • \n

    \n CreateDBInstance\n

    \n
    • \n
  • \n

    \n ModifyDBInstance\n

    \n
    • \n
  • \n

    \n RestoreDBInstanceFromDBSnapshot\n

    \n
    • \n
  • \n

    \n RestoreDBInstanceFromS3\n

    \n
    • \n
  • \n

    \n RestoreDBInstanceToPointInTime\n

    \n
    • \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
  • \n

    \n DescribeDBInstances\n

    \n
    • \n
  • \n

    \n DescribeDBSnapshots\n

    \n
    • \n
  • \n

    \n DescribeValidDBInstanceModifications\n

    \n
    • \n
\n

If you call DescribeDBInstances, ProcessorFeature returns\n non-null values only if the following conditions are met:

\n
    \n
  • \n

    You are accessing an Oracle DB instance.

    \n
    • \n
  • \n

    Your Oracle DB instance class supports configuring the number of CPU cores and threads per core.

    \n
    • \n
  • \n

    The current number CPU cores and threads is set to a non-default value.

    \n
    • \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": { @@ -16418,7 +16415,7 @@ } ], "traits": { - "smithy.api#documentation": "

Promotes a read replica DB instance to a standalone DB instance.

\n \n
    \n
  • \n

    Backup duration is a function of the amount of changes to the database since the previous\n backup. If you plan to promote a read replica to a standalone instance, we\n recommend that you enable backups and complete at least one backup prior to\n promotion. In addition, a read replica cannot be promoted to a standalone\n instance when it is in the backing-up status. If you have\n enabled backups on your read replica, configure the automated backup window\n so that daily backups do not interfere with read replica\n promotion.

    \n
    • \n
  • \n

    This command doesn't apply to Aurora MySQL, Aurora PostgreSQL, or RDS Custom.

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

Promotes a read replica DB instance to a standalone DB instance.

\n \n
    \n
  • \n

    Backup duration is a function of the amount of changes to the database since the previous\n backup. If you plan to promote a read replica to a standalone instance, we\n recommend that you enable backups and complete at least one backup prior to\n promotion. In addition, a read replica cannot be promoted to a standalone\n instance when it is in the backing-up status. If you have\n enabled backups on your read replica, configure the automated backup window\n so that daily backups do not interfere with read replica\n promotion.

    \n
    • \n
  • \n

    This command doesn't apply to Aurora MySQL, Aurora PostgreSQL, or RDS Custom.

    \n
    • \n
\n " } }, "com.amazonaws.rds#PromoteReadReplicaDBCluster": { @@ -16447,7 +16444,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
  • \n

    Must match the identifier of an existing DB cluster read replica.

    \n
    • \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
  • \n

    Must match the identifier of an existing DB cluster read replica.

    \n
    • \n
\n

Example: my-cluster-replica1\n

", "smithy.api#required": {} } } @@ -16470,20 +16467,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
  • \n

    Must match the identifier of an existing read replica DB instance.

    \n
    • \n
\n

Example: mydbinstance\n

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

The DB instance identifier. This value is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing read replica DB instance.

    \n
    • \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
    \n
  • \n

    Must be a value from 0 to 35.

    \n
    • \n
  • \n

    Can't be set to 0 if the DB instance is a source to read replicas.

    \n
    • \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
    \n
  • \n

    Must be a value from 0 to 35.

    \n
    • \n
  • \n

    Can't be set to 0 if the DB instance is a source to read replicas.

    \n
    • \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
    \n
  • \n

    Must be in the format hh24:mi-hh24:mi.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred maintenance window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \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
    \n
  • \n

    Must be in the format hh24:mi-hh24:mi.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred maintenance window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \n
" } } }, @@ -16545,20 +16542,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": { @@ -16595,7 +16592,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...

" } } }, @@ -16665,7 +16662,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 The Multi-AZ DB clusters feature is in preview and is subject to change.

\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": { @@ -16674,7 +16671,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
    \n
  • \n

    Must match the identifier of an existing DBCluster.

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

The DB cluster identifier. This parameter is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DBCluster.

    \n
    • \n
", "smithy.api#required": {} } } @@ -16705,7 +16702,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": { @@ -16714,14 +16711,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
    \n
  • \n

    Must match the identifier of an existing DBInstance.

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

The DB instance identifier. This parameter is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DBInstance.

    \n
    • \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.

" } } }, @@ -16754,7 +16751,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": { @@ -16868,7 +16865,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": { @@ -16877,13 +16874,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.

" } } } @@ -16913,7 +16910,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

\n \n

The Multi-AZ DB clusters feature is in preview and is subject to change.

\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": { @@ -16981,7 +16978,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": {} } } @@ -17020,7 +17017,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": {} } } @@ -17060,7 +17057,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": { @@ -17196,12 +17193,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": { @@ -17236,7 +17233,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": { @@ -17247,7 +17244,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": { @@ -17349,7 +17346,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": { @@ -17367,7 +17364,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": { @@ -17378,7 +17375,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": { @@ -17415,7 +17412,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

\n \n

The Multi-AZ DB clusters feature is in preview and is subject to change.

\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": { @@ -17462,7 +17459,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": { @@ -17471,20 +17468,20 @@ "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the DB parameter group.

\n

Constraints:

\n
    \n
  • \n

    Must match the name of an existing DBParameterGroup.

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

The name of the DB parameter group.

\n

Constraints:

\n
    \n
  • \n

    Must match the name of an existing DBParameterGroup.

    \n
    • \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

" } } }, @@ -17582,7 +17579,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": { @@ -17597,7 +17594,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
    \n
  • \n

    Must be a value from 1 to 35

    \n
    • \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
    \n
  • \n

    Must be a value from 1 to 35

    \n
    • \n
" } }, "CharacterSetName": { @@ -17615,14 +17612,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
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \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
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \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
    \n
  • \n

    If supplied, must match the name of an existing DBClusterParameterGroup.

    \n
    • \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
    \n
  • \n

    If supplied, must match the name of an existing DBClusterParameterGroup.

    \n
    • \n
" } }, "VpcSecurityGroupIds": { @@ -17640,26 +17637,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
    \n
  • \n

    Must be 1 to 16 letters or numbers.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't be a reserved word for the chosen database engine.

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

The name of the master user for the restored DB cluster.

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 16 letters or numbers.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't be a reserved word for the chosen database engine.

    \n
    • \n
", "smithy.api#required": {} } }, @@ -17679,13 +17676,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
    \n
  • \n

    Must be in the format hh24:mi-hh24:mi.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred maintenance window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \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
    \n
  • \n

    Must be in the format hh24:mi-hh24:mi.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred maintenance window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \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": { @@ -17706,20 +17703,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": {} } }, @@ -17746,19 +17743,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
    \n
  • \n

    If specified, this value must be set to a number from 0 to 259,200 (72 hours).

    \n
    • \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
    \n
  • \n

    If specified, this value must be set to a number from 0 to 259,200 (72 hours).

    \n
    • \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. For more information, see \n 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": { @@ -17770,7 +17767,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": { @@ -17851,7 +17848,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

\n \n

The Multi-AZ DB clusters feature is in preview and is subject to change.

\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": { @@ -17860,100 +17857,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
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \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
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \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
  • \n

    Must match the identifier of an existing Snapshot.

    \n
    • \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
  • \n

    Must match the identifier of an existing Snapshot.

    \n
    • \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
  • \n

    If the DB snapshot or DB cluster snapshot in\n SnapshotIdentifier is encrypted, then the restored DB cluster\n is encrypted using the KMS key that was used to encrypt the DB snapshot or DB\n cluster snapshot.

    \n
    • \n
  • \n

    If the DB snapshot or DB cluster snapshot in \n SnapshotIdentifier isn't encrypted, then the restored DB cluster\n isn't encrypted.

    \n
    • \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
  • \n

    If the DB snapshot or DB cluster snapshot in\n SnapshotIdentifier is encrypted, then the restored DB cluster\n is encrypted using the KMS key that was used to encrypt the DB snapshot or DB\n cluster snapshot.

    \n
    • \n
  • \n

    If the DB snapshot or DB cluster snapshot in \n SnapshotIdentifier isn't encrypted, then the restored DB cluster\n isn't encrypted.

    \n
    • \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
  • \n

    If specified, this value must be set to a number from 0 to 259,200 (72 hours).

    \n
    • \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
  • \n

    If specified, this value must be set to a number from 0 to 259,200 (72 hours).

    \n
    • \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

For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon\n Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" + "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": { @@ -17965,7 +17962,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
  • \n

    If supplied, must match the name of an existing default DB cluster parameter group.

    \n
    • \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \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
  • \n

    If supplied, must match the name of an existing default DB cluster parameter group.

    \n
    • \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "DeletionProtection": { @@ -17977,13 +17974,13 @@ "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "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": { @@ -17995,25 +17992,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
  • \n

    If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.

    \n
    • \n
  • \n

    If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

    \n
    • \n
\n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n
    \n
  • \n

    If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.

    \n
    • \n
  • \n

    If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.

    \n
    • \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
  • \n

    If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.

    \n
    • \n
  • \n

    If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

    \n
    • \n
\n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n
    \n
  • \n

    If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.

    \n
    • \n
  • \n

    If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.

    \n
    • \n
\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } } }, @@ -18094,7 +18091,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

\n \n

The Multi-AZ DB clusters feature is in preview and is subject to change.

\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": { @@ -18103,57 +18100,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
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \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
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \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
  • \n

    \n full-copy - The new DB cluster is restored as a full copy of the\n source DB cluster.

    \n
    • \n
  • \n

    \n copy-on-write - The new DB cluster is restored as a clone of the\n source DB cluster.

    \n
    • \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
  • \n

    \n full-copy - The new DB cluster is restored as a full copy of the\n source DB cluster.

    \n
    • \n
  • \n

    \n copy-on-write - The new DB cluster is restored as a clone of the\n source DB cluster.

    \n
    • \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
  • \n

    Must match the identifier of an existing DBCluster.

    \n
    • \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
  • \n

    Must match the identifier of an existing DBCluster.

    \n
    • \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
  • \n

    Must be before the latest restorable time for the DB instance

    \n
    • \n
  • \n

    Must be specified if UseLatestRestorableTime parameter isn't provided

    \n
    • \n
  • \n

    Can't be specified if the UseLatestRestorableTime parameter is enabled

    \n
    • \n
  • \n

    Can't be specified if the RestoreType parameter is copy-on-write\n

    \n
    • \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
  • \n

    Must be before the latest restorable time for the DB instance

    \n
    • \n
  • \n

    Must be specified if UseLatestRestorableTime parameter isn't provided

    \n
    • \n
  • \n

    Can't be specified if the UseLatestRestorableTime parameter is enabled

    \n
    • \n
  • \n

    Can't be specified if the RestoreType parameter is copy-on-write\n

    \n
    • \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": { @@ -18162,31 +18159,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
  • \n

    If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.

    \n
    • \n
  • \n

    If the DB cluster isn't encrypted, then the restored DB cluster isn't encrypted.

    \n
    • \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
  • \n

    If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.

    \n
    • \n
  • \n

    If the DB cluster isn't encrypted, then the restored DB cluster isn't encrypted.

    \n
    • \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
  • \n

    If specified, this value must be set to a number from 0 to 259,200 (72 hours).

    \n
    • \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
  • \n

    If specified, this value must be set to a number from 0 to 259,200 (72 hours).

    \n
    • \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

For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" + "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
  • \n

    If supplied, must match the name of an existing DB cluster parameter group.

    \n
    • \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \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
  • \n

    If supplied, must match the name of an existing DB cluster parameter group.

    \n
    • \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "DeletionProtection": { @@ -18198,13 +18195,13 @@ "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "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": { @@ -18222,31 +18219,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
  • \n

    If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.

    \n
    • \n
  • \n

    If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

    \n
    • \n
\n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n
    \n
  • \n

    If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.

    \n
    • \n
  • \n

    If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.

    \n
    • \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
  • \n

    If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.

    \n
    • \n
  • \n

    If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

    \n
    • \n
\n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n
    \n
  • \n

    If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.

    \n
    • \n
  • \n

    If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.

    \n
    • \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

" } } }, @@ -18333,7 +18330,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": { @@ -18342,87 +18339,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
  • \n

    Must contain from 1 to 63 numbers, letters, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \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
  • \n

    Must contain from 1 to 63 numbers, letters, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \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
    \n
  • \n

    Must match the identifier of an existing DBSnapshot.

    \n
    • \n
  • \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
", + "smithy.api#documentation": "

The identifier for the DB snapshot to restore from.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DBSnapshot.

    \n
    • \n
  • \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
", "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
    \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

    \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
    \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

    \n
    • \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": { @@ -18431,49 +18428,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": { @@ -18503,7 +18500,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": { @@ -18515,7 +18512,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
  • \n

    The profile must exist in your account.

    \n
    • \n
  • \n

    The profile must have an IAM role that Amazon EC2 has permissions to assume.

    \n
    • \n
  • \n

    The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    \n
    • \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
  • \n

    The profile must exist in your account.

    \n
    • \n
  • \n

    The profile must have an IAM role that Amazon EC2 has permissions to assume.

    \n
    • \n
  • \n

    The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    \n
    • \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": { @@ -18599,7 +18596,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": { @@ -18608,46 +18605,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

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \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
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \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
    \n
  • \n

    Must be 1 to 16 letters or numbers.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't be a reserved word for the chosen database engine.

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

The name for the master user.

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 16 letters or numbers.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't be a reserved word for the chosen database engine.

    \n
    • \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": { @@ -18659,13 +18656,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": { @@ -18677,7 +18674,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
    \n
  • \n

    Must be in the format ddd:hh24:mi-ddd:hh24:mi.

    \n
    • \n
  • \n

    Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred backup window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \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
    \n
  • \n

    Must be in the format ddd:hh24:mi-ddd:hh24:mi.

    \n
    • \n
  • \n

    Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred backup window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \n
" } }, "DBParameterGroupName": { @@ -18689,149 +18686,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
    \n
  • \n

    Must be in the format hh24:mi-hh24:mi.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred maintenance window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \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
    \n
  • \n

    Must be in the format hh24:mi-hh24:mi.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred maintenance window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \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": { @@ -18843,7 +18840,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": { @@ -18867,7 +18864,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": { @@ -18963,7 +18960,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": { @@ -18972,98 +18969,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
    \n
  • \n

    Must match the identifier of an existing DB instance.

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

The identifier of the source DB instance from which to restore.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DB instance.

    \n
    • \n
" } }, "TargetDBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the new DB instance to be created.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

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

The name of the new DB instance to be created.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \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
  • \n

    Must be before the latest restorable time for the DB instance

    \n
    • \n
  • \n

    Can't be specified if the UseLatestRestorableTime parameter is enabled

    \n
    • \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
  • \n

    Must be before the latest restorable time for the DB instance

    \n
    • \n
  • \n

    Can't be specified if the UseLatestRestorableTime parameter is enabled

    \n
    • \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
    \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

    \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
    \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

    \n
    • \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": { @@ -19078,43 +19075,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": { @@ -19144,7 +19141,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": { @@ -19156,7 +19153,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": { @@ -19174,7 +19171,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
  • \n

    The profile must exist in your account.

    \n
    • \n
  • \n

    The profile must have an IAM role that Amazon EC2 has permissions to assume.

    \n
    • \n
  • \n

    The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    \n
    • \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
  • \n

    The profile must exist in your account.

    \n
    • \n
  • \n

    The profile must have an IAM role that Amazon EC2 has permissions to assume.

    \n
    • \n
  • \n

    The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    \n
    • \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": { @@ -19252,25 +19249,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.

" } } }, @@ -19355,7 +19352,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": { @@ -19367,18 +19364,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": { @@ -19399,7 +19396,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": { @@ -19411,7 +19408,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": { @@ -19422,7 +19419,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": { @@ -19532,13 +19529,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.

" } } }, @@ -19630,7 +19627,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": {} } }, @@ -19716,7 +19713,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": { @@ -19783,7 +19780,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": { @@ -19859,7 +19856,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": {} } } @@ -19911,7 +19908,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": { @@ -19920,7 +19917,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": {} } }, @@ -19941,14 +19938,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
    \n
  • \n

    GrantOperation.Encrypt

    \n
    • \n
  • \n

    GrantOperation.Decrypt

    \n
    • \n
  • \n

    GrantOperation.GenerateDataKey

    \n
    • \n
  • \n

    GrantOperation.GenerateDataKeyWithoutPlaintext

    \n
    • \n
  • \n

    GrantOperation.ReEncryptFrom

    \n
    • \n
  • \n

    GrantOperation.ReEncryptTo

    \n
    • \n
  • \n

    GrantOperation.CreateGrant

    \n
    • \n
  • \n

    GrantOperation.DescribeKey

    \n
    • \n
  • \n

    GrantOperation.RetireGrant

    \n
    • \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
    \n
  • \n

    GrantOperation.Encrypt

    \n
    • \n
  • \n

    GrantOperation.Decrypt

    \n
    • \n
  • \n

    GrantOperation.GenerateDataKey

    \n
    • \n
  • \n

    GrantOperation.GenerateDataKeyWithoutPlaintext

    \n
    • \n
  • \n

    GrantOperation.ReEncryptFrom

    \n
    • \n
  • \n

    GrantOperation.ReEncryptTo

    \n
    • \n
  • \n

    GrantOperation.CreateGrant

    \n
    • \n
  • \n

    GrantOperation.DescribeKey

    \n
    • \n
  • \n

    GrantOperation.RetireGrant

    \n
    • \n
", "smithy.api#required": {} } }, @@ -19961,7 +19958,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
    \n
  • \n

    \n database - Export all the data from a specified database.

    \n
    • \n
  • \n

    \n database.table \n table-name - \n Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.

    \n
    • \n
  • \n

    \n database.schema \n schema-name - Export a database schema of the snapshot. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

    \n
    • \n
  • \n

    \n database.schema.table \n table-name - Export a table of the database schema. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

    \n
    • \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
    \n
  • \n

    \n database - Export all the data from a specified database.

    \n
    • \n
  • \n

    \n database.table\n table-name - \n Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.

    \n
    • \n
  • \n

    \n database.schema\n schema-name - Export a database schema of the snapshot. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

    \n
    • \n
  • \n

    \n database.schema.table\n table-name - Export a table of the database schema. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

    \n
    • \n
" } } } @@ -20001,7 +19998,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": {} } }, @@ -20056,7 +20053,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": { @@ -20105,7 +20102,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": { @@ -20154,14 +20151,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.

" } } } @@ -20203,7 +20200,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 } @@ -20259,7 +20256,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": { @@ -20398,7 +20395,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": { @@ -20407,7 +20404,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.

" } } }, @@ -20427,7 +20424,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": { @@ -20548,7 +20545,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": { @@ -20707,18 +20704,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": { @@ -20727,25 +20724,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": { @@ -20756,7 +20753,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/aws/sdk/aws-models/robomaker.json b/aws/sdk/aws-models/robomaker.json index c908b04b8d..d15e47aa36 100644 --- a/aws/sdk/aws-models/robomaker.json +++ b/aws/sdk/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/aws/sdk/aws-models/route53-recovery-cluster.json b/aws/sdk/aws-models/route53-recovery-cluster.json index 5f5cf9ccd2..38f24ce160 100644 --- a/aws/sdk/aws-models/route53-recovery-cluster.json +++ b/aws/sdk/aws-models/route53-recovery-cluster.json @@ -52,7 +52,13 @@ "min": 1, "max": 255 }, - "smithy.api#pattern": "^[A-Za-z0-9:\\/_-]*$" + "smithy.api#pattern": "^[A-Za-z0-9:.\\/_-]*$" + } + }, + "com.amazonaws.route53recoverycluster#Arns": { + "type": "list", + "member": { + "target": "com.amazonaws.route53recoverycluster#Arn" } }, "com.amazonaws.route53recoverycluster#ConflictException": { @@ -131,7 +137,7 @@ } ], "traits": { - "smithy.api#documentation": "

Get the state for a routing control. A routing control is a simple on/off switch\n\t\t\t\tthat you can use to route traffic to cells. When the state is On, traffic flows to a cell. When it's off, traffic does not flow.

\n\t\t\t

Before you can create a routing control, you first must create a cluster to host the control.\n\t\t\t\tFor more information, see \n\t\t\t\tCreateCluster.\n\t\t\t\tAccess one of the endpoints for the cluster to get or update the routing control state to\n\t\t\t\tredirect traffic.

\n\t\t\t

For more information about working with routing controls, see \n\t\t\t\tRouting control\n\t\t\t\tin the Route 53 Application Recovery Controller Developer Guide.

" + "smithy.api#documentation": "

Get the state for a routing control. A routing control is a simple on/off switch that you\n\t\t\tcan use to route traffic to cells. When the state is On, traffic flows to a cell. When\n\t\t\tit's Off, traffic does not flow.

\n\t\t\t

Before you can create a routing control, you must first create a cluster to host the control\n\t\t\t\tin a control panel. For more information, see \n\t\t\t\t\tCreate routing control structures in the Amazon Route 53 Application Recovery Controller Developer Guide. \n\t\t\t\tThen you access one of the endpoints for the cluster to get or update the routing control state to\n\t\t\t\tredirect traffic.

\n\t\t\t

\n You must specify Regional endpoints when you work with API cluster operations \n\t\t\t\tto get or update routing control states in Application Recovery Controller.\n

\n\t\t\t

To see a code example for getting a routing control state, including accessing Regional cluster endpoints\n\t\t\t\tin sequence, see API examples\n\t\t\t\tin the Amazon Route 53 Application Recovery Controller Developer Guide.

\n\t\t\t

Learn more about working with routing controls in the following topics in the \n\t\t\t\tAmazon Route 53 Application Recovery Controller Developer Guide:

\n\t\t\t " } }, "com.amazonaws.route53recoverycluster#GetRoutingControlStateRequest": { @@ -265,18 +271,6 @@ }, "com.amazonaws.route53recoverycluster#ToggleCustomerAPI": { "type": "service", - "version": "2019-12-02", - "operations": [ - { - "target": "com.amazonaws.route53recoverycluster#GetRoutingControlState" - }, - { - "target": "com.amazonaws.route53recoverycluster#UpdateRoutingControlState" - }, - { - "target": "com.amazonaws.route53recoverycluster#UpdateRoutingControlStates" - } - ], "traits": { "aws.api#service": { "sdkId": "Route53 Recovery Cluster", @@ -289,9 +283,21 @@ "name": "route53-recovery-cluster" }, "aws.protocols#awsJson1_0": {}, - "smithy.api#documentation": "

Welcome to the Amazon Route 53 Application Recovery Controller API Reference Guide for Recovery Control Data Plane .

\n\t\t\t

Recovery control in Route 53 Application Recovery Controller includes extremely reliable routing controls that enable you to recover applications \n\t\t\t\tby rerouting traffic, for example, across Availability Zones or AWS Regions. Routing controls are simple on/off switches \n\t\t\t\thosted on a cluster. A cluster is a set of five redundant regional endpoints against which you can execute API calls to update or \n\t\t\t\tget the state of routing controls. You use routing controls to failover traffic to recover your application \n\t\t\t\tacross Availability Zones or Regions.

\n\t\t\t

This API guide includes information about how to get and update routing control states in Route 53 Application Recovery Controller.

\n\t\t\t

For more information about Route 53 Application Recovery Controller, see the following:

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

Welcome to the Routing Control (Recovery Cluster) API Reference Guide for Amazon Route 53 Application Recovery Controller.

\n\t\t\t

With Amazon Route 53 Application Recovery Controller, you can use routing control with extreme reliability to\n\t\t\trecover applications by rerouting traffic across\n\t\t\tAvailability Zones or AWS Regions. Routing controls are simple on/off switches hosted\n\t\t\ton a highly available cluster in Application Recovery Controller. A cluster provides a set of five redundant Regional endpoints against which you\n\t\t\tcan run API calls to get or update the state of routing controls. To implement failover, you set \n\t\t\tone routing control on and another one off, to reroute traffic from one Availability Zone or Amazon Web Services Region \n\t\t\tto another.

\n\t\t\t

\n Be aware that you must specify the Regional endpoints for a cluster when you work with API cluster operations \n\t\t\t\tto get or update routing control states in Application Recovery Controller. In addition, you must specify the US West (Oregon) Region \n\t\t\t\tfor Application Recovery Controller API calls. For example, use the parameter region us-west-2 with AWS CLI commands.\n\t\t\t\tFor more information, see\n\t\t\t\t\n\t\t\t\t\tGet and update routing control states using the API in the Amazon Route 53 Application Recovery Controller Developer Guide.

\n\t\t

This API guide includes information about the API operations for how to get and update routing control states\n\t\t\tin Application Recovery Controller. You also must set up the structures to support routing controls: clusters and control panels.

\n\t\t\t

For more information about working with routing control in Application Recovery Controller, see the following:

\n\t\t ", "smithy.api#title": "Route53 Recovery Cluster" - } + }, + "version": "2019-12-02", + "operations": [ + { + "target": "com.amazonaws.route53recoverycluster#GetRoutingControlState" + }, + { + "target": "com.amazonaws.route53recoverycluster#UpdateRoutingControlState" + }, + { + "target": "com.amazonaws.route53recoverycluster#UpdateRoutingControlStates" + } + ] }, "com.amazonaws.route53recoverycluster#UpdateRoutingControlState": { "type": "operation", @@ -325,7 +331,7 @@ } ], "traits": { - "smithy.api#documentation": "

Set the state of the routing control to reroute traffic. You can set the value to be On or Off.\n\t\t\t\tWhen the state is On, traffic flows to a cell. When it's off, traffic does not flow.

\n\t\t\t

For more information about working with routing controls, see \n\t\t\t\tRouting control\n\t\t\t\tin the Route 53 Application Recovery Controller Developer Guide.

" + "smithy.api#documentation": "

Set the state of the routing control to reroute traffic. You can set the value to be On or\n\t\t\tOff. When the state is On, traffic flows to a cell. When it's Off, traffic does not\n\t\t\tflow.

\n\t\t\t

With Application Recovery Controller, you can add safety rules for routing controls, which are safeguards for routing \n\t\t\t\tcontrol state updates that help prevent unexpected outcomes, like fail open traffic routing. However, \n\t\t\t\tthere are scenarios when you might want to bypass the routing control safeguards that are enforced with \n\t\t\t\tsafety rules that you've configured. For example, you might want to fail over quickly for disaster recovery, \n\t\t\t\tand one or more safety rules might be unexpectedly preventing you from updating a routing control state to \n\t\t\t\treroute traffic. In a \"break glass\" scenario like this, you can override one or more safety rules to change \n\t\t\t\ta routing control state and fail over your application.

\n\t\t\t

The SafetyRulesToOverride property enables you override one or more safety rules and \n\t\t\t\tupdate routing control states. For more information, see \n\t\t\t\t\n\t\t\t\t\tOverride safety rules to reroute traffic in the Amazon Route 53 Application Recovery Controller Developer Guide.

\n\t\t\t

\n You must specify Regional endpoints when you work with API cluster operations \n\t\t\t\tto get or update routing control states in Application Recovery Controller.\n

\n\t\t\t

To see a code example for getting a routing control state, including accessing Regional cluster endpoints\n\t\t\t\tin sequence, see API examples\n\t\t\t\tin the Amazon Route 53 Application Recovery Controller Developer Guide.

\n\t\t\t " } }, "com.amazonaws.route53recoverycluster#UpdateRoutingControlStateEntries": { @@ -340,7 +346,7 @@ "RoutingControlArn": { "target": "com.amazonaws.route53recoverycluster#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) for the routing control state entry.

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

The Amazon Resource Number (ARN) for a routing control state entry.

", "smithy.api#required": {} } }, @@ -353,7 +359,7 @@ } }, "traits": { - "smithy.api#documentation": "

A routing control state.

" + "smithy.api#documentation": "

A routing control state entry.

" } }, "com.amazonaws.route53recoverycluster#UpdateRoutingControlStateRequest": { @@ -372,6 +378,12 @@ "smithy.api#documentation": "

The state of the routing control. You can set the value to be On or Off.

", "smithy.api#required": {} } + }, + "SafetyRulesToOverride": { + "target": "com.amazonaws.route53recoverycluster#Arns", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Numbers (ARNs) for the safety rules that you want to override when you're updating the state of\n\t\t\ta routing control. You can override one safety rule or multiple safety rules by including one or more ARNs, separated \n\t\t\tby commas.

\n\t\t

For more information, see \n\t\t\tOverride safety rules to reroute traffic in the Amazon Route 53 Application Recovery Controller Developer Guide.

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

Set multiple routing control states. You can set the value for each state to be On or Off.\n\t\t\tWhen the state is On, traffic flows to a cell. When it's off, traffic does not flow.

\n\t\t\t

For more information about working with routing controls, see \n\t\t\t\tRouting control\n\t\t\t\tin the Route 53 Application Recovery Controller Developer Guide.

" + "smithy.api#documentation": "

Set multiple routing control states. You can set the value for each state to be On or Off.\n\t\t\tWhen the state is On, traffic flows to a cell. When it's Off, traffic does not\n\t\t\tflow.

\n\t\t\t

With Application Recovery Controller, you can add safety rules for routing controls, which are safeguards for routing \n\t\t\t\tcontrol state updates that help prevent unexpected outcomes, like fail open traffic routing. However, \n\t\t\t\tthere are scenarios when you might want to bypass the routing control safeguards that are enforced with \n\t\t\t\tsafety rules that you've configured. For example, you might want to fail over quickly for disaster recovery, \n\t\t\t\tand one or more safety rules might be unexpectedly preventing you from updating a routing control state to \n\t\t\t\treroute traffic. In a \"break glass\" scenario like this, you can override one or more safety rules to change \n\t\t\t\ta routing control state and fail over your application.

\n\t\t\t

The SafetyRulesToOverride property enables you override one or more safety rules and \n\t\t\t\tupdate routing control states. For more information, see \n\t\t\t\t\n\t\t\t\t\tOverride safety rules to reroute traffic in the Amazon Route 53 Application Recovery Controller Developer Guide.

\t\t\t\n

\n You must specify Regional endpoints when you work with API cluster operations \n\t\t\t\tto get or update routing control states in Application Recovery Controller.\n

\n\t\t\t

To see a code example for getting a routing control state, including accessing Regional cluster endpoints\n\t\t\t\tin sequence, see API examples\n\t\t\t\tin the Amazon Route 53 Application Recovery Controller Developer Guide.

\n\t\t\t " } }, "com.amazonaws.route53recoverycluster#UpdateRoutingControlStatesRequest": { @@ -423,6 +435,12 @@ "smithy.api#documentation": "

A set of routing control entries that you want to update.

", "smithy.api#required": {} } + }, + "SafetyRulesToOverride": { + "target": "com.amazonaws.route53recoverycluster#Arns", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Numbers (ARNs) for the safety rules that you want to override when you're updating routing\n\t\t\tcontrol states. You can override one safety rule or multiple safety rules by including one or more ARNs, separated \n\t\t\tby commas.

\n\t\t

For more information, see \n\t\t\tOverride safety rules to reroute traffic in the Amazon Route 53 Application Recovery Controller Developer Guide.

" + } } } }, diff --git a/aws/sdk/aws-models/s3control.json b/aws/sdk/aws-models/s3control.json index 1fdd844883..035a9cbdaf 100644 --- a/aws/sdk/aws-models/s3control.json +++ b/aws/sdk/aws-models/s3control.json @@ -6137,6 +6137,29 @@ ] } }, + "com.amazonaws.s3control#S3ChecksumAlgorithm": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CRC32", + "name": "CRC32" + }, + { + "value": "CRC32C", + "name": "CRC32C" + }, + { + "value": "SHA1", + "name": "SHA1" + }, + { + "value": "SHA256", + "name": "SHA256" + } + ] + } + }, "com.amazonaws.s3control#S3ContentLength": { "type": "long", "traits": { @@ -6249,6 +6272,12 @@ "traits": { "smithy.api#documentation": "

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with\n server-side encryption using Amazon Web Services KMS (SSE-KMS). Setting this header to true\n causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

\n

Specifying this header with an object action doesn’t affect\n bucket-level settings for S3 Bucket Key.

" } + }, + "ChecksumAlgorithm": { + "target": "com.amazonaws.s3control#S3ChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "

Indicates the algorithm you want Amazon S3 to use to create the checksum. For more information\n see \n Checking object integrity in the Amazon S3 User Guide.

" + } } }, "traits": { diff --git a/aws/sdk/aws-models/secretsmanager.json b/aws/sdk/aws-models/secretsmanager.json index d912185b67..3f0024bce5 100644 --- a/aws/sdk/aws-models/secretsmanager.json +++ b/aws/sdk/aws-models/secretsmanager.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/aws/sdk/aws-models/servicecatalog-appregistry.json b/aws/sdk/aws-models/servicecatalog-appregistry.json index 34209543ae..9cae82b889 100644 --- a/aws/sdk/aws-models/servicecatalog-appregistry.json +++ b/aws/sdk/aws-models/servicecatalog-appregistry.json @@ -31,6 +31,21 @@ "shapes": { "com.amazonaws.servicecatalogappregistry#AWS242AppRegistry": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Service Catalog AppRegistry", + "arnNamespace": "servicecatalog", + "cloudFormationName": "ServiceCatalogAppRegistry", + "cloudTrailEventSource": "servicecatalogappregistry.amazonaws.com", + "endpointPrefix": "servicecatalog-appregistry" + }, + "aws.auth#sigv4": { + "name": "servicecatalog" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

Amazon Web Services Service Catalog AppRegistry enables organizations to understand the application context of their Amazon Web Services resources. AppRegistry provides a repository of your applications, their resources, and the application metadata that you use within your enterprise.

", + "smithy.api#title": "AWS Service Catalog App Registry" + }, "version": "2020-06-24", "operations": [ { @@ -96,22 +111,7 @@ { "target": "com.amazonaws.servicecatalogappregistry#UpdateAttributeGroup" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Service Catalog AppRegistry", - "arnNamespace": "servicecatalog", - "cloudFormationName": "ServiceCatalogAppRegistry", - "cloudTrailEventSource": "servicecatalogappregistry.amazonaws.com", - "endpointPrefix": "servicecatalog-appregistry" - }, - "aws.auth#sigv4": { - "name": "servicecatalog" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

Amazon Web Services Service Catalog AppRegistry enables organizations to understand the application context of their Amazon Web Services resources. AppRegistry provides a repository of your applications, their resources, and the application metadata that you use within your enterprise.

", - "smithy.api#title": "AWS Service Catalog App Registry" - } + ] }, "com.amazonaws.servicecatalogappregistry#Application": { "type": "structure", @@ -2107,6 +2107,9 @@ "name": { "target": "com.amazonaws.servicecatalogappregistry#Name", "traits": { + "smithy.api#deprecated": { + "message": "Name update for application is deprecated." + }, "smithy.api#documentation": "

The new name of the application. The name must be unique in the region in which you are updating the application.

" } }, @@ -2174,6 +2177,9 @@ "name": { "target": "com.amazonaws.servicecatalogappregistry#Name", "traits": { + "smithy.api#deprecated": { + "message": "Name update for attribute group is deprecated." + }, "smithy.api#documentation": "

The new name of the attribute group. The name must be unique in the region in which you are\n updating the attribute group.

" } }, diff --git a/aws/sdk/aws-models/sts.json b/aws/sdk/aws-models/sts.json index 85099f3845..a1cb802e72 100644 --- a/aws/sdk/aws-models/sts.json +++ b/aws/sdk/aws-models/sts.json @@ -100,7 +100,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a set of temporary security credentials that you can use to access Amazon Web Services\n resources that you might not normally have access to. These temporary credentials consist\n of an access key ID, a secret access key, and a security token. Typically, you use\n AssumeRole within your account or for cross-account access. For a\n comparison of AssumeRole with other API operations that produce temporary\n credentials, see Requesting Temporary Security\n Credentials and Comparing the\n Amazon Web Services STS API operations in the IAM User Guide.

\n

\n Permissions\n

\n

The temporary security credentials created by AssumeRole can be used to\n make API calls to any Amazon Web Services service with the following exception: You cannot call the\n Amazon Web Services STS GetFederationToken or GetSessionToken API\n operations.

\n

(Optional) You can pass inline or managed session policies to\n this operation. You can pass a single JSON policy document to use as an inline session\n policy. You can also specify up to 10 managed policies to use as managed session policies.\n The plaintext that you use for both inline and managed session policies can't exceed 2,048\n characters. Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent Amazon Web Services API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.

\n

When you create a role, you create two policies: A role trust policy that specifies\n who can assume the role and a permissions policy that specifies\n what can be done with the role. You specify the trusted principal\n who is allowed to assume the role in the role trust policy.

\n

To assume a role from a different account, your Amazon Web Services account must be trusted by the\n role. The trust relationship is defined in the role's trust policy when the role is\n created. That trust policy states which accounts are allowed to delegate that access to\n users in the account.

\n

A user who wants to access a role in a different account must also have permissions that\n are delegated from the user account administrator. The administrator must attach a policy\n that allows the user to call AssumeRole for the ARN of the role in the other\n account.

\n

To allow a user to assume a role in the same account, you can do either of the\n following:

\n
    \n
  • \n

    Attach a policy to the user that allows the user to call\n AssumeRole (as long as the role's trust policy trusts the account).

    \n
    • \n
  • \n

    Add the user as a principal directly in the role's trust policy.

    \n
    • \n
\n

You can do either because the role’s trust policy acts as an IAM resource-based\n policy. When a resource-based policy grants access to a principal in the same account, no\n additional identity-based policy is required. For more information about trust policies and\n resource-based policies, see IAM Policies in the\n IAM User Guide.

\n\n

\n Tags\n

\n

(Optional) You can pass tag key-value pairs to your session. These tags are called\n session tags. For more information about session tags, see Passing Session Tags in STS in the\n IAM User Guide.

\n

An administrator must grant you the permissions necessary to pass session tags. The\n administrator can also create granular permissions to allow you to pass only specific\n session tags. For more information, see Tutorial: Using Tags\n for Attribute-Based Access Control in the\n IAM User Guide.

\n

You can set the session tags as transitive. Transitive tags persist during role\n chaining. For more information, see Chaining Roles\n with Session Tags in the IAM User Guide.

\n

\n Using MFA with AssumeRole\n

\n

(Optional) You can include multi-factor authentication (MFA) information when you call\n AssumeRole. This is useful for cross-account scenarios to ensure that the\n user that assumes the role has been authenticated with an Amazon Web Services MFA device. In that\n scenario, the trust policy of the role being assumed includes a condition that tests for\n MFA authentication. If the caller does not include valid MFA information, the request to\n assume the role is denied. The condition in a trust policy that tests for MFA\n authentication might look like the following example.

\n

\n \"Condition\": {\"Bool\": {\"aws:MultiFactorAuthPresent\": true}}\n

\n

For more information, see Configuring MFA-Protected API Access\n in the IAM User Guide guide.

\n

To use MFA with AssumeRole, you pass values for the\n SerialNumber and TokenCode parameters. The\n SerialNumber value identifies the user's hardware or virtual MFA device.\n The TokenCode is the time-based one-time password (TOTP) that the MFA device\n produces.

" + "smithy.api#documentation": "

Returns a set of temporary security credentials that you can use to access Amazon Web Services\n resources that you might not normally have access to. These temporary credentials consist\n of an access key ID, a secret access key, and a security token. Typically, you use\n AssumeRole within your account or for cross-account access. For a\n comparison of AssumeRole with other API operations that produce temporary\n credentials, see Requesting Temporary Security\n Credentials and Comparing the\n Amazon Web Services STS API operations in the IAM User Guide.

\n

\n Permissions\n

\n

The temporary security credentials created by AssumeRole can be used to\n make API calls to any Amazon Web Services service with the following exception: You cannot call the\n Amazon Web Services STS GetFederationToken or GetSessionToken API\n operations.

\n

(Optional) You can pass inline or managed session policies to\n this operation. You can pass a single JSON policy document to use as an inline session\n policy. You can also specify up to 10 managed policies to use as managed session policies.\n The plaintext that you use for both inline and managed session policies can't exceed 2,048\n characters. Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent Amazon Web Services API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.

\n

When you create a role, you create two policies: A role trust policy that specifies\n who can assume the role and a permissions policy that specifies\n what can be done with the role. You specify the trusted principal\n who is allowed to assume the role in the role trust policy.

\n

To assume a role from a different account, your Amazon Web Services account must be trusted by the\n role. The trust relationship is defined in the role's trust policy when the role is\n created. That trust policy states which accounts are allowed to delegate that access to\n users in the account.

\n

A user who wants to access a role in a different account must also have permissions that\n are delegated from the user account administrator. The administrator must attach a policy\n that allows the user to call AssumeRole for the ARN of the role in the other\n account.

\n

To allow a user to assume a role in the same account, you can do either of the\n following:

\n
    \n
  • \n

    Attach a policy to the user that allows the user to call AssumeRole\n (as long as the role's trust policy trusts the account).

    \n
    • \n
  • \n

    Add the user as a principal directly in the role's trust policy.

    \n
    • \n
\n

You can do either because the role’s trust policy acts as an IAM resource-based\n policy. When a resource-based policy grants access to a principal in the same account, no\n additional identity-based policy is required. For more information about trust policies and\n resource-based policies, see IAM Policies in the\n IAM User Guide.

\n\n

\n Tags\n

\n

(Optional) You can pass tag key-value pairs to your session. These tags are called\n session tags. For more information about session tags, see Passing Session Tags in STS in the\n IAM User Guide.

\n

An administrator must grant you the permissions necessary to pass session tags. The\n administrator can also create granular permissions to allow you to pass only specific\n session tags. For more information, see Tutorial: Using Tags\n for Attribute-Based Access Control in the\n IAM User Guide.

\n

You can set the session tags as transitive. Transitive tags persist during role\n chaining. For more information, see Chaining Roles\n with Session Tags in the IAM User Guide.

\n

\n Using MFA with AssumeRole\n

\n

(Optional) You can include multi-factor authentication (MFA) information when you call\n AssumeRole. This is useful for cross-account scenarios to ensure that the\n user that assumes the role has been authenticated with an Amazon Web Services MFA device. In that\n scenario, the trust policy of the role being assumed includes a condition that tests for\n MFA authentication. If the caller does not include valid MFA information, the request to\n assume the role is denied. The condition in a trust policy that tests for MFA\n authentication might look like the following example.

\n

\n \"Condition\": {\"Bool\": {\"aws:MultiFactorAuthPresent\": true}}\n

\n

For more information, see Configuring MFA-Protected API Access\n in the IAM User Guide guide.

\n

To use MFA with AssumeRole, you pass values for the\n SerialNumber and TokenCode parameters. The\n SerialNumber value identifies the user's hardware or virtual MFA device.\n The TokenCode is the time-based one-time password (TOTP) that the MFA device\n produces.

" } }, "com.amazonaws.sts#AssumeRoleRequest": { @@ -141,7 +141,7 @@ "Tags": { "target": "com.amazonaws.sts#tagListType", "traits": { - "smithy.api#documentation": "

A list of session tags that you want to pass. Each session tag consists of a key name\n and an associated value. For more information about session tags, see Tagging Amazon Web Services STS\n Sessions in the IAM User Guide.

\n

This parameter is optional. You can pass up to 50 session tags. The plaintext session\n tag keys can’t exceed 128 characters, and the values can’t exceed 256 characters. For these\n and additional limits, see IAM\n and STS Character Limits in the IAM User Guide.

\n \n \n

An Amazon Web Services conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plaintext meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n

\n \n \n

You can pass a session tag with the same key as a tag that is already attached to the\n role. When you do, session tags override a role tag with the same key.

\n

Tag key–value pairs are not case sensitive, but case is preserved. This means that you\n cannot have separate Department and department tag keys. Assume\n that the role has the Department=Marketing tag and you pass the\n department=engineering session tag. Department\n and department are not saved as separate tags, and the session tag passed in\n the request takes precedence over the role tag.

\n

Additionally, if you used temporary credentials to perform this operation, the new\n session inherits any transitive session tags from the calling session. If you pass a\n session tag with the same key as an inherited tag, the operation fails. To view the\n inherited tags for a session, see the CloudTrail logs. For more information, see Viewing Session Tags in CloudTrail in the\n IAM User Guide.

" + "smithy.api#documentation": "

A list of session tags that you want to pass. Each session tag consists of a key name\n and an associated value. For more information about session tags, see Tagging Amazon Web Services STS\n Sessions in the IAM User Guide.

\n

This parameter is optional. You can pass up to 50 session tags. The plaintext session\n tag keys can’t exceed 128 characters, and the values can’t exceed 256 characters. For these\n and additional limits, see IAM\n and STS Character Limits in the IAM User Guide.

\n \n \n

An Amazon Web Services conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plaintext meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n

\n \n \n

You can pass a session tag with the same key as a tag that is already attached to the\n role. When you do, session tags override a role tag with the same key.

\n

Tag key–value pairs are not case sensitive, but case is preserved. This means that you\n cannot have separate Department and department tag keys. Assume\n that the role has the Department=Marketing tag and you pass the\n department=engineering session tag. Department\n and department are not saved as separate tags, and the session tag passed in\n the request takes precedence over the role tag.

\n

Additionally, if you used temporary credentials to perform this operation, the new\n session inherits any transitive session tags from the calling session. If you pass a\n session tag with the same key as an inherited tag, the operation fails. To view the\n inherited tags for a session, see the CloudTrail logs. For more information, see Viewing Session Tags in CloudTrail in the\n IAM User Guide.

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

Returns a set of temporary security credentials for users who have been authenticated in\n a mobile or web application with a web identity provider. Example providers include Amazon Cognito,\n Login with Amazon, Facebook, Google, or any OpenID Connect-compatible identity\n provider.

\n \n

For mobile applications, we recommend that you use Amazon Cognito. You can use Amazon Cognito with the\n Amazon Web Services SDK for iOS Developer Guide and the Amazon Web Services SDK for Android Developer Guide to uniquely\n identify a user. You can also supply the user with a consistent identity throughout the\n lifetime of an application.

\n

To learn more about Amazon Cognito, see Amazon Cognito Overview in\n Amazon Web Services SDK for Android Developer Guide and Amazon Cognito Overview in the\n Amazon Web Services SDK for iOS Developer Guide.

\n \n

Calling AssumeRoleWithWebIdentity does not require the use of Amazon Web Services\n security credentials. Therefore, you can distribute an application (for example, on mobile\n devices) that requests temporary security credentials without including long-term Amazon Web Services\n credentials in the application. You also don't need to deploy server-based proxy services\n that use long-term Amazon Web Services credentials. Instead, the identity of the caller is validated by\n using a token from the web identity provider. For a comparison of\n AssumeRoleWithWebIdentity with the other API operations that produce\n temporary credentials, see Requesting Temporary Security\n Credentials and Comparing the\n Amazon Web Services STS API operations in the IAM User Guide.

\n

The temporary security credentials returned by this API consist of an access key ID, a\n secret access key, and a security token. Applications can use these temporary security\n credentials to sign calls to Amazon Web Services service API operations.

\n

\n Session Duration\n

\n

By default, the temporary security credentials created by\n AssumeRoleWithWebIdentity last for one hour. However, you can use the\n optional DurationSeconds parameter to specify the duration of your session.\n You can provide a value from 900 seconds (15 minutes) up to the maximum session duration\n setting for the role. This setting can have a value from 1 hour to 12 hours. To learn how\n to view the maximum value for your role, see View the\n Maximum Session Duration Setting for a Role in the\n IAM User Guide. The maximum session duration limit applies when\n you use the AssumeRole* API operations or the assume-role* CLI\n commands. However the limit does not apply when you use those operations to create a\n console URL. For more information, see Using IAM Roles in the\n IAM User Guide.

\n

\n Permissions\n

\n

The temporary security credentials created by AssumeRoleWithWebIdentity can\n be used to make API calls to any Amazon Web Services service with the following exception: you cannot\n call the STS GetFederationToken or GetSessionToken API\n operations.

\n

(Optional) You can pass inline or managed session policies to\n this operation. You can pass a single JSON policy document to use as an inline session\n policy. You can also specify up to 10 managed policies to use as managed session policies.\n The plaintext that you use for both inline and managed session policies can't exceed 2,048\n characters. Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent Amazon Web Services API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.

\n

\n Tags\n

\n

(Optional) You can configure your IdP to pass attributes into your web identity token as\n session tags. Each session tag consists of a key name and an associated value. For more\n information about session tags, see Passing Session Tags in STS in the\n IAM User Guide.

\n

You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128\n characters and the values can’t exceed 256 characters. For these and additional limits, see\n IAM\n and STS Character Limits in the IAM User Guide.

\n \n \n

An Amazon Web Services conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plaintext meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n

\n \n \n

You can pass a session tag with the same key as a tag that is attached to the role. When\n you do, the session tag overrides the role tag with the same key.

\n

An administrator must grant you the permissions necessary to pass session tags. The\n administrator can also create granular permissions to allow you to pass only specific\n session tags. For more information, see Tutorial: Using Tags\n for Attribute-Based Access Control in the\n IAM User Guide.

\n

You can set the session tags as transitive. Transitive tags persist during role\n chaining. For more information, see Chaining Roles\n with Session Tags in the IAM User Guide.

\n

\n Identities\n

\n

Before your application can call AssumeRoleWithWebIdentity, you must have\n an identity token from a supported identity provider and create a role that the application\n can assume. The role that your application assumes must trust the identity provider that is\n associated with the identity token. In other words, the identity provider must be specified\n in the role's trust policy.

\n \n

Calling AssumeRoleWithWebIdentity can result in an entry in your\n CloudTrail logs. The entry includes the Subject of\n the provided web identity token. We recommend that you avoid using any personally\n identifiable information (PII) in this field. For example, you could instead use a GUID\n or a pairwise identifier, as suggested\n in the OIDC specification.

\n \n

For more information about how to use web identity federation and the\n AssumeRoleWithWebIdentity API, see the following resources:

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

Returns a set of temporary security credentials for users who have been authenticated in\n a mobile or web application with a web identity provider. Example providers include the\n OAuth 2.0 providers Login with Amazon and Facebook, or any OpenID Connect-compatible\n identity provider such as Google or Amazon Cognito federated identities.

\n \n

For mobile applications, we recommend that you use Amazon Cognito. You can use Amazon Cognito with the\n Amazon Web Services SDK for iOS Developer Guide and the Amazon Web Services SDK for Android Developer Guide to uniquely\n identify a user. You can also supply the user with a consistent identity throughout the\n lifetime of an application.

\n

To learn more about Amazon Cognito, see Amazon Cognito Overview in\n Amazon Web Services SDK for Android Developer Guide and Amazon Cognito Overview in the\n Amazon Web Services SDK for iOS Developer Guide.

\n \n

Calling AssumeRoleWithWebIdentity does not require the use of Amazon Web Services\n security credentials. Therefore, you can distribute an application (for example, on mobile\n devices) that requests temporary security credentials without including long-term Amazon Web Services\n credentials in the application. You also don't need to deploy server-based proxy services\n that use long-term Amazon Web Services credentials. Instead, the identity of the caller is validated by\n using a token from the web identity provider. For a comparison of\n AssumeRoleWithWebIdentity with the other API operations that produce\n temporary credentials, see Requesting Temporary Security\n Credentials and Comparing the\n Amazon Web Services STS API operations in the IAM User Guide.

\n

The temporary security credentials returned by this API consist of an access key ID, a\n secret access key, and a security token. Applications can use these temporary security\n credentials to sign calls to Amazon Web Services service API operations.

\n

\n Session Duration\n

\n

By default, the temporary security credentials created by\n AssumeRoleWithWebIdentity last for one hour. However, you can use the\n optional DurationSeconds parameter to specify the duration of your session.\n You can provide a value from 900 seconds (15 minutes) up to the maximum session duration\n setting for the role. This setting can have a value from 1 hour to 12 hours. To learn how\n to view the maximum value for your role, see View the\n Maximum Session Duration Setting for a Role in the\n IAM User Guide. The maximum session duration limit applies when\n you use the AssumeRole* API operations or the assume-role* CLI\n commands. However the limit does not apply when you use those operations to create a\n console URL. For more information, see Using IAM Roles in the\n IAM User Guide.

\n

\n Permissions\n

\n

The temporary security credentials created by AssumeRoleWithWebIdentity can\n be used to make API calls to any Amazon Web Services service with the following exception: you cannot\n call the STS GetFederationToken or GetSessionToken API\n operations.

\n

(Optional) You can pass inline or managed session policies to\n this operation. You can pass a single JSON policy document to use as an inline session\n policy. You can also specify up to 10 managed policies to use as managed session policies.\n The plaintext that you use for both inline and managed session policies can't exceed 2,048\n characters. Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent Amazon Web Services API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.

\n

\n Tags\n

\n

(Optional) You can configure your IdP to pass attributes into your web identity token as\n session tags. Each session tag consists of a key name and an associated value. For more\n information about session tags, see Passing Session Tags in STS in the\n IAM User Guide.

\n

You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128\n characters and the values can’t exceed 256 characters. For these and additional limits, see\n IAM\n and STS Character Limits in the IAM User Guide.

\n \n \n

An Amazon Web Services conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plaintext meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n

\n \n \n

You can pass a session tag with the same key as a tag that is attached to the role. When\n you do, the session tag overrides the role tag with the same key.

\n

An administrator must grant you the permissions necessary to pass session tags. The\n administrator can also create granular permissions to allow you to pass only specific\n session tags. For more information, see Tutorial: Using Tags\n for Attribute-Based Access Control in the\n IAM User Guide.

\n

You can set the session tags as transitive. Transitive tags persist during role\n chaining. For more information, see Chaining Roles\n with Session Tags in the IAM User Guide.

\n

\n Identities\n

\n

Before your application can call AssumeRoleWithWebIdentity, you must have\n an identity token from a supported identity provider and create a role that the application\n can assume. The role that your application assumes must trust the identity provider that is\n associated with the identity token. In other words, the identity provider must be specified\n in the role's trust policy.

\n \n

Calling AssumeRoleWithWebIdentity can result in an entry in your\n CloudTrail logs. The entry includes the Subject of\n the provided web identity token. We recommend that you avoid using any personally\n identifiable information (PII) in this field. For example, you could instead use a GUID\n or a pairwise identifier, as suggested\n in the OIDC specification.

\n \n

For more information about how to use web identity federation and the\n AssumeRoleWithWebIdentity API, see the following resources:

\n " } }, "com.amazonaws.sts#AssumeRoleWithWebIdentityRequest": { @@ -408,7 +408,7 @@ "ProviderId": { "target": "com.amazonaws.sts#urlType", "traits": { - "smithy.api#documentation": "

The fully qualified host component of the domain name of the identity provider.

\n

Specify this value only for OAuth 2.0 access tokens. Currently\n www.amazon.com and graph.facebook.com are the only supported\n identity providers for OAuth 2.0 access tokens. Do not include URL schemes and port\n numbers.

\n

Do not specify this value for OpenID Connect ID tokens.

" + "smithy.api#documentation": "

The fully qualified host component of the domain name of the OAuth 2.0 identity\n provider. Do not specify this value for an OpenID Connect identity provider.

\n

Currently www.amazon.com and graph.facebook.com are the only\n supported identity providers for OAuth 2.0 access tokens. Do not include URL schemes and\n port numbers.

\n

Do not specify this value for OpenID Connect ID tokens.

" } }, "PolicyArns": { diff --git a/aws/sdk/aws-models/synthetics.json b/aws/sdk/aws-models/synthetics.json index 4f53264ebe..9482d1469e 100644 --- a/aws/sdk/aws-models/synthetics.json +++ b/aws/sdk/aws-models/synthetics.json @@ -262,9 +262,9 @@ } }, "Handler": { - "target": "com.amazonaws.synthetics#String", + "target": "com.amazonaws.synthetics#CodeHandler", "traits": { - "smithy.api#documentation": "

The entry point to use for the source code when running the canary. This value must end\n with the string .handler. The string is limited to 29 characters or fewer.

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

The entry point to use for the source code when running the canary. For canaries that use the \n syn-python-selenium-1.0 runtime\n or a syn-nodejs.puppeteer runtime earlier than syn-nodejs.puppeteer-3.4, \n the handler must be specified as \n fileName.handler. For \n syn-python-selenium-1.1, syn-nodejs.puppeteer-3.4, and later runtimes, the handler can be specified as \n \n fileName.functionName\n , or\n you can specify a folder where canary scripts reside as \n\n folder/fileName.functionName\n .

", "smithy.api#required": {} } } @@ -658,6 +658,16 @@ "smithy.api#documentation": "

This structure contains information about when the canary was created and modified.

" } }, + "com.amazonaws.synthetics#CodeHandler": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^([0-9a-zA-Z_-]+\\/)*[0-9A-Za-z_\\\\-]+\\.[A-Za-z_][A-Za-z0-9_]*$" + } + }, "com.amazonaws.synthetics#ConflictException": { "type": "structure", "members": { diff --git a/aws/sdk/aws-models/timestream-query.json b/aws/sdk/aws-models/timestream-query.json index d63d85b139..a2cd21ad2e 100644 --- a/aws/sdk/aws-models/timestream-query.json +++ b/aws/sdk/aws-models/timestream-query.json @@ -84,7 +84,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": true }, - "smithy.api#documentation": "

Cancels a query that has been issued. Cancellation is provided only if the query has\n not completed running before the cancellation request was issued. Because cancellation\n is an idempotent operation, subsequent cancellation requests will return a\n CancellationMessage, indicating that the query has already been\n canceled. See code\n sample for details.

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

Cancels a query that has been issued. Cancellation is provided only if the query has\n not completed running before the cancellation request was issued. Because cancellation\n is an idempotent operation, subsequent cancellation requests will return a\n CancellationMessage, indicating that the query has already been\n canceled. See code\n sample for details.

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

DescribeEndpoints returns a list of available endpoints to make Timestream\n API calls against. This API is available through both Write and Query.

\n

Because the Timestream SDKs are designed to transparently work with the\n service’s architecture, including the management and mapping of the service endpoints,\n it is not recommended that you use this API unless:

\n \n

For detailed information on how and when to use and implement DescribeEndpoints, see\n The Endpoint Discovery Pattern.

" + "smithy.api#documentation": "

DescribeEndpoints returns a list of available endpoints to make Timestream\n API calls against. This API is available through both Write and Query.

\n

Because the Timestream SDKs are designed to transparently work with the\n service’s architecture, including the management and mapping of the service endpoints,\n it is not recommended that you use this API unless:

\n \n

For detailed information on how and when to use and implement DescribeEndpoints, see\n The Endpoint Discovery Pattern.

" } }, "com.amazonaws.timestreamquery#DescribeEndpointsRequest": { @@ -1199,7 +1199,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": true }, - "smithy.api#documentation": "

\n Query is a synchronous operation that enables you to run a query against\n your Amazon Timestream data. Query will time out after 60 seconds.\n You must update the default timeout in the SDK to support a timeout of 60 seconds. See\n the code\n sample for details.

\n

Your query request will fail in the following cases:

\n
    \n
  • \n

    If you submit a Query request with the same client token outside\n of the 5-minute idempotency window.

    \n
    • \n
  • \n

    If you submit a Query request with the same client token, but\n change other parameters, within the 5-minute idempotency window.

    \n
    • \n
  • \n

    If the size of the row (including the query metadata) exceeds 1 MB, then the\n query will fail with the following error message:

    \n

    \n Query aborted as max page response size has been exceeded by the output\n result row\n

    \n
    • \n
  • \n

    If the IAM principal of the query initiator and the result reader are not the\n same and/or the query initiator and the result reader do not have the same query\n string in the query requests, the query will fail with an Invalid\n pagination token error.

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

\n Query is a synchronous operation that enables you to run a query against\n your Amazon Timestream data. Query will time out after 60 seconds.\n You must update the default timeout in the SDK to support a timeout of 60 seconds. See\n the code\n sample for details.

\n

Your query request will fail in the following cases:

\n
    \n
  • \n

    If you submit a Query request with the same client token outside\n of the 5-minute idempotency window.

    \n
    • \n
  • \n

    If you submit a Query request with the same client token, but\n change other parameters, within the 5-minute idempotency window.

    \n
    • \n
  • \n

    If the size of the row (including the query metadata) exceeds 1 MB, then the\n query will fail with the following error message:

    \n

    \n Query aborted as max page response size has been exceeded by the output\n result row\n

    \n
    • \n
  • \n

    If the IAM principal of the query initiator and the result reader are not the\n same and/or the query initiator and the result reader do not have the same query\n string in the query requests, the query will fail with an Invalid\n pagination token error.

    \n
    • \n
", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", @@ -1484,6 +1484,10 @@ { "value": "VARCHAR", "name": "VARCHAR" + }, + { + "value": "TIMESTAMP", + "name": "TIMESTAMP" } ] } diff --git a/aws/sdk/aws-models/transcribe-streaming.json b/aws/sdk/aws-models/transcribe-streaming.json index c3bc9f9eed..3f54217ce2 100644 --- a/aws/sdk/aws-models/transcribe-streaming.json +++ b/aws/sdk/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,-._]+$" + } } } } diff --git a/aws/sdk/aws-models/transcribe.json b/aws/sdk/aws-models/transcribe.json index c2137684d6..2502718d75 100644 --- a/aws/sdk/aws-models/transcribe.json +++ b/aws/sdk/aws-models/transcribe.json @@ -503,7 +503,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an analytics category. Amazon Transcribe applies the conditions specified by your\n analytics categories to your call analytics jobs. For each analytics category, you specify one \n or more rules. For example, you can specify a rule that the customer sentiment was neutral \n or negative within that category. If you start a call analytics job, Amazon Transcribe applies the\n category to the analytics job that you've specified.

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

Creates a call analytics category. Amazon Transcribe applies the conditions specified by your\n call analytics categories to your call analytics jobs. For each analytics category, you \n must create between 1 and 20 rules. For example, you can create a 'greeting' \n category with a rule that flags calls in which your agent does not use a specified \n phrase (for example: \"Please note this call may be recorded.\") in the first 15 seconds\n of the call. When you start a call analytics job, Amazon Transcribe applies all your existing call\n analytics categories to that job.

", "smithy.api#http": { "method": "PUT", "uri": "/callanalyticscategories/{CategoryName}", @@ -517,7 +517,7 @@ "CategoryName": { "target": "com.amazonaws.transcribe#CategoryName", "traits": { - "smithy.api#documentation": "

The name that you choose for your category when you create it.

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

A unique name, chosen by you, for your call analytics category. For example, \n sentiment-positive-last30seconds.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -525,7 +525,7 @@ "Rules": { "target": "com.amazonaws.transcribe#RuleList", "traits": { - "smithy.api#documentation": "

To create a category, you must specify between 1 and 20 rules. For each rule, you \n specify a filter to be applied to the attributes of the call. For example, you can specify a \n sentiment filter to detect if the customer's sentiment was negative or neutral.

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

Rules make up a call analytics category. When creating a call analytics category,\n you must create between 1 and 20 rules for your category. For each rule, you \n specify a filter you want applied to the attributes of a call. For example, you can choose\n a sentiment filter that detects if a customer's sentiment was positive during the last\n 30 seconds of the call.

", "smithy.api#required": {} } } @@ -537,7 +537,7 @@ "CategoryProperties": { "target": "com.amazonaws.transcribe#CategoryProperties", "traits": { - "smithy.api#documentation": "

The rules and associated metadata used to create a category.

" + "smithy.api#documentation": "

If your audio matches one of your categories, this field contains data on that \n category and its associated rules. This parameter shows which category is flagged\n (CategoryName) along with metadata for the rules that match your \n audio. Metadata includes the rule filter (such as InterruptionFilter,\n NonTalkTimeFilter, SentimentFilter, and \n TranscriptFilter) and where in your audio (StartTime\n and EndTime) the rule has a match.

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

Creates a new custom language model. Use Amazon S3 prefixes to provide the location of \n your input files. The time it takes to create your model depends on the size of your training\n data.

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

Creates a new custom language model. When creating a new language model, \n you must specify if you want a Wideband (audio sample rates over 16,000 Hz) or\n Narrowband (audio sample rates under 16,000 Hz) base model. You then include the \n S3 URI location of your training and tuning files, the language for the model, a \n unique name, and any tags you want associated with your model.

", "smithy.api#http": { "method": "PUT", "uri": "/languagemodels/{ModelName}", @@ -579,21 +579,21 @@ "LanguageCode": { "target": "com.amazonaws.transcribe#CLMLanguageCode", "traits": { - "smithy.api#documentation": "

The language of the input text you're using to train your custom language\n model.

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

The language of your custom language model; note that the language code you\n select must match the language of your training and tuning data.

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

The Amazon Transcribe standard language model, or base model used to create your custom\n language model.

\n

If you want to use your custom language model to transcribe audio with a sample rate \n of 16,000 Hz or greater, choose Wideband.

\n

If you want to use your custom language model to transcribe audio with a sample rate \n that is less than 16,000 Hz, choose Narrowband.

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

The Amazon Transcribe standard language model, or base model, used to create your \n custom language model. Amazon Transcribe offers two options for base models: Wideband and\n Narrowband.

\n

If the audio you want to transcribe has a sample rate of 16,000 Hz or greater, \n choose WideBand. To transcribe audio with a sample rate less than\n 16,000 Hz, choose NarrowBand.

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

The name you choose for your custom language model when you create it.

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

The name of your new custom language model.

\n

This name is case sensitive, cannot contain spaces, and must be unique within an \n Amazon Web Services account. If you try to create a language model with the same name as a\n previous language model, you get a ConflictException error.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -601,14 +601,14 @@ "InputDataConfig": { "target": "com.amazonaws.transcribe#InputDataConfig", "traits": { - "smithy.api#documentation": "

Contains the data access role and the Amazon S3 prefixes to read the required input files to\n create a custom language model.

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

Contains your data access role ARN (Amazon Resource Name) and the Amazon S3 \n locations of your training (S3Uri) and tuning \n (TuningDataS3Uri) data.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.transcribe#TagList", "traits": { - "smithy.api#documentation": "

Adds one or more tags, each in the form of a key:value pair, to a new language model \n at the time you create this new model.

" + "smithy.api#documentation": "

Optionally add tags, each in the form of a key:value pair, to your new language\n model. See also: .

" } } } @@ -619,31 +619,31 @@ "LanguageCode": { "target": "com.amazonaws.transcribe#CLMLanguageCode", "traits": { - "smithy.api#documentation": "

The language code of the text you've used to create a custom language model.

" + "smithy.api#documentation": "

The language code you selected for your custom language model.

" } }, "BaseModelName": { "target": "com.amazonaws.transcribe#BaseModelName", "traits": { - "smithy.api#documentation": "

The Amazon Transcribe standard language model, or base model you've used to create a custom\n language model.

" + "smithy.api#documentation": "

The Amazon Transcribe standard language model, or base model, you used when creating your\n custom language model.

\n

If your audio has a sample rate of 16,000 Hz or greater, this value should be\n WideBand. If your audio has a sample rate of less than\n 16,000 Hz, this value should be NarrowBand.

" } }, "ModelName": { "target": "com.amazonaws.transcribe#ModelName", "traits": { - "smithy.api#documentation": "

The name you've chosen for your custom language model.

" + "smithy.api#documentation": "

The unique name you chose for your custom language model.

" } }, "InputDataConfig": { "target": "com.amazonaws.transcribe#InputDataConfig", "traits": { - "smithy.api#documentation": "

The data access role and Amazon S3 prefixes you've chosen to create your custom language model.

" + "smithy.api#documentation": "

Lists your data access role ARN (Amazon Resource Name) and the Amazon S3 \n locations your provided for your training (S3Uri) and tuning \n (TuningDataS3Uri) data.

" } }, "ModelStatus": { "target": "com.amazonaws.transcribe#ModelStatus", "traits": { - "smithy.api#documentation": "

The status of the custom language model. When the status is \n COMPLETED the model is ready to use.

" + "smithy.api#documentation": "

The status of your custom language model. When the status shows as \n COMPLETED, your model is ready to use.

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

Creates a new custom vocabulary that you can use to modify how Amazon Transcribe Medical transcribes\n your audio file.

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

Creates a new custom medical vocabulary.

\n

When creating a new medical vocabulary, you must upload a text file that contains\n your new entries, phrases, and terms into an S3 bucket. Note that this differs from \n , where you can include a list of terms within\n your request using the Phrases flag, as\n CreateMedicalVocabulary does not support the Phrases\n flag.

\n

For more information on creating a custom vocabulary text file, see \n Creating a custom \n vocabulary.

", "smithy.api#http": { "method": "PUT", "uri": "/medicalvocabularies/{VocabularyName}", @@ -685,7 +685,7 @@ "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

The name of the custom vocabulary. This case-sensitive name must be unique within\n an Amazon Web Services account. If you try to create a vocabulary with the same name \n as a previous vocabulary, you get a ConflictException error.

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

The name of your new vocabulary.

\n

This name is case sensitive, cannot contain spaces, and must be unique within an \n Amazon Web Services account. If you try to create a vocabulary with the same name as a\n previous vocabulary, you get a ConflictException error.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -693,21 +693,21 @@ "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language code for the language used for the entries in your custom vocabulary.\n The language code of your custom vocabulary must match the language code of your \n transcription job. US English (en-US) is the only language code available for Amazon Transcribe Medical.

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

The language code that represents the language of the entries in your custom\n vocabulary. Note that U.S. English (en-US) is the only language \n supported with Amazon Transcribe Medical.

", "smithy.api#required": {} } }, "VocabularyFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The location in Amazon S3 of the text file you use to define your custom vocabulary. The URI \n must be in the same Amazon Web Services Region as the resource that you're calling. Enter\n information about your VocabularyFileUri in the following format:

\n

\n https://s3..amazonaws.com///\n

\n

The following is an example URI for a vocabulary file that is stored in Amazon S3:

\n

\n https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt\n

\n

For more information about Amazon S3 object names, see Object Keys in \n the Amazon S3 Developer Guide.

\n

For more information about custom vocabularies, see Medical Custom\n Vocabularies.

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

The Amazon S3 location (URI) of the text file that contains your custom vocabulary. \n The URI must be in the same Amazon Web Services Region as the resource that you're \n calling.

\n

Here's an example URI path:

\n

\n https://s3.us-east-1.amazonaws.com/my-s3-bucket/my-vocab-file.txt\n

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.transcribe#TagList", "traits": { - "smithy.api#documentation": "

Adds one or more tags, each in the form of a key:value pair, to a new medical \n vocabulary at the time you create this new vocabulary.

" + "smithy.api#documentation": "

Adds one or more tags, each in the form of a key:value pair, to a new medical \n vocabulary at the time you create the new vocabulary.

\n

To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

" } } } @@ -718,31 +718,31 @@ "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

The name of the vocabulary. The name must be unique within an Amazon Web Services \n account and is case sensitive.

" + "smithy.api#documentation": "

The name you chose for your vocabulary.

" } }, "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language code for the entries in your custom vocabulary. US English (en-US) is the \n only valid language code for Amazon Transcribe Medical.

" + "smithy.api#documentation": "

The language code you selected for your medical vocabulary. Note that U.S. English\n (en-US) is the only language supported with Amazon Transcribe Medical.

" } }, "VocabularyState": { "target": "com.amazonaws.transcribe#VocabularyState", "traits": { - "smithy.api#documentation": "

The processing state of your custom vocabulary in Amazon Transcribe Medical. If the state is \n READY, you can use the vocabulary in a \n StartMedicalTranscriptionJob request.

" + "smithy.api#documentation": "

The processing state of your custom medical vocabulary. If the state is \n READY, you can use the vocabulary in a \n StartMedicalTranscriptionJob request.

" } }, "LastModifiedTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time that you created the vocabulary.

" + "smithy.api#documentation": "

The date and time you created your custom medical vocabulary.

" } }, "FailureReason": { "target": "com.amazonaws.transcribe#FailureReason", "traits": { - "smithy.api#documentation": "

If the VocabularyState field is FAILED, this field contains\n information about why the job failed.

" + "smithy.api#documentation": "

If the VocabularyState field is FAILED,\n FailureReason contains information about why the job failed.

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

Creates a new custom vocabulary that you can use to change the way Amazon Transcribe handles transcription of an\n audio file.

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

Creates a new custom vocabulary.

\n

When creating a new medical vocabulary, you can either upload a text file that\n contains your new entries, phrases, and terms into an S3 bucket or include a list of \n terms directly in your request using the Phrases flag.

\n

For more information on creating a custom vocabulary, see \n Creating a custom \n vocabulary.

", "smithy.api#http": { "method": "PUT", "uri": "/vocabularies/{VocabularyName}", @@ -801,7 +801,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new vocabulary filter that you can use to filter words, such as profane words, \n from the output of a transcription job.

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

Creates a new vocabulary filter that you can use to filter words from your transcription\n output. For example, you can use this operation to remove profanity from your\n transcript.

", "smithy.api#http": { "method": "POST", "uri": "/vocabularyFilters/{VocabularyFilterName}", @@ -815,7 +815,7 @@ "VocabularyFilterName": { "target": "com.amazonaws.transcribe#VocabularyFilterName", "traits": { - "smithy.api#documentation": "

The vocabulary filter name. The name must be unique within the account that contains \n it. If you try to create a vocabulary filter with the same name as another vocabulary filter, you\n get a ConflictException error.

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

The name of your new vocabulary filter.

\n

This name is case sensitive, cannot contain spaces, and must be unique within an \n Amazon Web Services account. If you try to create a vocabulary filter with the same name \n as a previous vocabulary filter, you get a ConflictException error.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -830,19 +830,19 @@ "Words": { "target": "com.amazonaws.transcribe#Words", "traits": { - "smithy.api#documentation": "

The words to use in the vocabulary filter. Only use characters from the character set \n defined for custom vocabularies. For a list of character sets, see Character Sets for Custom\n Vocabularies.

\n

If you provide a list of words in the Words parameter, you can't use the\n VocabularyFilterFileUri parameter.

" + "smithy.api#documentation": "

The words you want in your vocabulary filter. Only use characters specified in the\n Character\n sets for the language you're transcribing.

\n

Note that if you include Words in your request, you cannot use\n VocabularyFilterFileUri; you must choose one or the other.

" } }, "VocabularyFilterFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The Amazon S3 location of a text file used as input to create the vocabulary filter. Only \n use characters from the character set defined for custom vocabularies. For a list of character \n sets, see Character Sets for Custom\n Vocabularies.

\n

The specified file must be less than 50 KB of UTF-8 characters.

\n

If you provide the location of a list of words in the VocabularyFilterFileUri\n parameter, you can't use the Words parameter.

" + "smithy.api#documentation": "

The Amazon S3 location of a text file used as input to create the vocabulary filter. Only \n use characters from the character set defined for custom vocabularies. For a list of \n character sets, see Character Sets for Custom\n Vocabularies.

\n

Your vocabulary filter file must be less than 50 KB in size.

\n

Note that if you include VocabularyFilterFileUri in your request, you \n cannot use Words; you must choose one or the other.

" } }, "Tags": { "target": "com.amazonaws.transcribe#TagList", "traits": { - "smithy.api#documentation": "

Adds one or more tags, each in the form of a key:value pair, to a new Amazon Transcribe vocabulary\n filter at the time you create this new vocabulary filter.

" + "smithy.api#documentation": "

Adds one or more tags, each in the form of a key:value pair, to a new vocabulary\n filter at the time you create this new vocabulary filter.

" } } } @@ -859,13 +859,13 @@ "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language code of the words in the collection.

" + "smithy.api#documentation": "

The language code associated with your vocabulary filter.

" } }, "LastModifiedTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time that the vocabulary filter was modified.

" + "smithy.api#documentation": "

The date and time the vocabulary filter was modified.

" } } } @@ -876,7 +876,7 @@ "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

The name of the vocabulary. The name must be unique within an \n Amazon Web Services account. The name is case sensitive. If you try to create a vocabulary \n with the same name as a previous vocabulary you will receive a \n ConflictException error.

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

The name of your new vocabulary.

\n

This name is case sensitive, cannot contain spaces, and must be unique within an \n Amazon Web Services account. If you try to create a vocabulary with the same name as a\n previous vocabulary, you get a ConflictException error.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -884,26 +884,26 @@ "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language code of the vocabulary entries. For a list of languages and their \n corresponding language codes, see table-language-matrix.

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

The language code that represents the language of the entries in your custom\n vocabulary. Each vocabulary must contain terms in only one language. For a list of \n languages and their corresponding language codes, see Supported \n languages.

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

An array of strings that contains the vocabulary entries.

" + "smithy.api#documentation": "

Use this flag to include a list of terms within your request.

\n

Note that if you include Phrases in your request, you cannot\n use VocabularyFileUri; you must choose one or the other.

" } }, "VocabularyFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The S3 location of the text file that contains the definition of the custom vocabulary. The\n URI must be in the same region as the API endpoint that you are calling. The general form \n is:

\n

\n https://s3..amazonaws.com/// \n

\n

For example:

\n

\n https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt\n

\n

For more information about S3 object names, see Object Keys in the \n Amazon S3 Developer Guide.

\n

For more information about custom vocabularies, see Custom vocabularies.

" + "smithy.api#documentation": "

The S3 location of the text file that contains your custom vocabulary. The\n URI must be located in the same region as the API endpoint you're calling.

\n

Here's an example URI path:

\n

\n https://s3.us-east-1.amazonaws.com/my-s3-bucket/my-vocab-file.txt\n

\n

Note that if you include VocabularyFileUri in your request, you \n cannot use the Phrases flag; you must choose one or the other.

" } }, "Tags": { "target": "com.amazonaws.transcribe#TagList", "traits": { - "smithy.api#documentation": "

Adds one or more tags, each in the form of a key:value pair, to a new Amazon Transcribe vocabulary at\n the time you create this new vocabulary.

" + "smithy.api#documentation": "

Adds one or more tags, each in the form of a key:value pair, to a new \n custom vocabulary at the time you create this new vocabulary.

" } } } @@ -914,31 +914,31 @@ "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

The name of the vocabulary.

" + "smithy.api#documentation": "

The name you chose for your vocabulary.

" } }, "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language code of the vocabulary entries.

" + "smithy.api#documentation": "

The language code you selected for your vocabulary.

" } }, "VocabularyState": { "target": "com.amazonaws.transcribe#VocabularyState", "traits": { - "smithy.api#documentation": "

The processing state of the vocabulary. When the VocabularyState field \n contains READY the vocabulary is ready to be used in a StartTranscriptionJob \n request.

" + "smithy.api#documentation": "

The processing state of your vocabulary. If the state is READY, you can\n use the vocabulary in a StartTranscriptionJob request.

" } }, "LastModifiedTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time that the vocabulary was created.

" + "smithy.api#documentation": "

The date and time you created your custom vocabulary.

" } }, "FailureReason": { "target": "com.amazonaws.transcribe#FailureReason", "traits": { - "smithy.api#documentation": "

If the VocabularyState field is FAILED, this field contains\n information about why the job failed.

" + "smithy.api#documentation": "

If the VocabularyState field is FAILED,\n FailureReason contains information about why the job failed.

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

Deletes a call analytics category using its name.

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

Deletes a call analytics category. To use this operation, specify the name of the \n category you want to delete using CategoryName.

", "smithy.api#http": { "method": "DELETE", "uri": "/callanalyticscategories/{CategoryName}", @@ -993,7 +993,7 @@ "CategoryName": { "target": "com.amazonaws.transcribe#CategoryName", "traits": { - "smithy.api#documentation": "

The name of the call analytics category that you're choosing to delete. The value is case\n sensitive.

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

The name of the call analytics category you want to delete. Category names are\n case-sensitive.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1024,7 +1024,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a call analytics job using its name.

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

Deletes a call analytics job. To use this operation, specify the name of the \n job you want to delete using CallAnalyticsJobName.

", "smithy.api#http": { "method": "DELETE", "uri": "/callanalyticsjobs/{CallAnalyticsJobName}", @@ -1038,7 +1038,7 @@ "CallAnalyticsJobName": { "target": "com.amazonaws.transcribe#CallAnalyticsJobName", "traits": { - "smithy.api#documentation": "

The name of the call analytics job you want to delete.

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

The name of the call analytics job you want to delete. Job names are\n case-sensitive.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1066,7 +1066,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a custom language model using its name.

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

Deletes a custom language model. To use this operation, specify the name of the \n language model you want to delete using ModelName.

", "smithy.api#http": { "method": "DELETE", "uri": "/languagemodels/{ModelName}", @@ -1080,7 +1080,7 @@ "ModelName": { "target": "com.amazonaws.transcribe#ModelName", "traits": { - "smithy.api#documentation": "

The name of the model you're choosing to delete.

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

The name of the model you want to delete. Model names are case-sensitive.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1104,7 +1104,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a transcription job generated by Amazon Transcribe Medical and any related information.

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

Deletes a medical transcription job, along with any related information. To use this \n operation, specify the name of the job you want to delete using\n MedicalTranscriptionJobName.

", "smithy.api#http": { "method": "DELETE", "uri": "/medicaltranscriptionjobs/{MedicalTranscriptionJobName}", @@ -1118,7 +1118,7 @@ "MedicalTranscriptionJobName": { "target": "com.amazonaws.transcribe#TranscriptionJobName", "traits": { - "smithy.api#documentation": "

The name you provide to the DeleteMedicalTranscriptionJob object to\n delete a transcription job.

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

The name of the medical transcription job you want to delete. Job names are\n case-sensitive.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1145,7 +1145,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a vocabulary from Amazon Transcribe Medical.

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

Deletes a custom medical vocabulary. To use this operation, specify the name of the\n vocabulary you want to delete using VocabularyName.

", "smithy.api#http": { "method": "DELETE", "uri": "/medicalvocabularies/{VocabularyName}", @@ -1159,7 +1159,7 @@ "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

The name of the vocabulary that you want to delete.

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

The name of the vocabulary that you want to delete. Vocabulary names are\n case-sensitive.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1183,7 +1183,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a previously submitted transcription job along with any other generated results such as the \n transcription, models, and so on.

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

Deletes a transcription job, along with any related information. To use this operation,\n specify the name of the job you want to delete using\n TranscriptionJobName.

", "smithy.api#http": { "method": "DELETE", "uri": "/transcriptionjobs/{TranscriptionJobName}", @@ -1197,7 +1197,7 @@ "TranscriptionJobName": { "target": "com.amazonaws.transcribe#TranscriptionJobName", "traits": { - "smithy.api#documentation": "

The name of the transcription job to be deleted.

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

The name of the transcription job you want to delete. Job names are\n case-sensitive.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1224,7 +1224,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a vocabulary from Amazon Transcribe.

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

Deletes a custom vocabulary. To use this operation, specify the name of the vocabulary \n you want to delete using VocabularyName.

", "smithy.api#http": { "method": "DELETE", "uri": "/vocabularies/{VocabularyName}", @@ -1252,7 +1252,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes a vocabulary filter.

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

Deletes a vocabulary filter. To use this operation, specify the name of the vocabulary \n filter you want to delete using VocabularyFilterName.

", "smithy.api#http": { "method": "DELETE", "uri": "/vocabularyFilters/{VocabularyFilterName}", @@ -1266,7 +1266,7 @@ "VocabularyFilterName": { "target": "com.amazonaws.transcribe#VocabularyFilterName", "traits": { - "smithy.api#documentation": "

The name of the vocabulary filter to remove.

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

The name of the vocabulary filter you want to delete. Vocabulary filter names are\n case-sensitive.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1279,7 +1279,7 @@ "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

The name of the vocabulary to delete.

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

The name of the vocabulary you want to delete. Vocabulary names are\n case-sensitive.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1309,7 +1309,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about a single custom language model. Use this information to see details about the \n language model in your Amazon Web Services account. You can also see whether the base language model used \n to create your custom language model has been updated. If Amazon Transcribe has updated the base model, you can create a\n new custom language model using the updated base model. If the language model wasn't created, you can use this\n operation to understand why Amazon Transcribe couldn't create it.

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

Provides information about a specific custom language model in your \n Amazon Web Services account.

\n

This operation also shows if the base language model you used to create your custom\n language model has been updated. If Amazon Transcribe has updated the base model, you can create a\n new custom language model using the updated base model.

\n

If you tried to create a new custom language model and the request wasn't successful,\n you can use this operation to help identify the reason.

", "smithy.api#http": { "method": "GET", "uri": "/languagemodels/{ModelName}", @@ -1323,7 +1323,7 @@ "ModelName": { "target": "com.amazonaws.transcribe#ModelName", "traits": { - "smithy.api#documentation": "

The name of the custom language model you submit to get more information.

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

The name of the custom language model you want described. Model names are\n case-sensitive.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1381,7 +1381,7 @@ "CategoryName": { "target": "com.amazonaws.transcribe#CategoryName", "traits": { - "smithy.api#documentation": "

The name of the category you want information about. This value is case sensitive.

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

The name of the category you want information about. Category names are case\n sensitive.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1394,7 +1394,7 @@ "CategoryProperties": { "target": "com.amazonaws.transcribe#CategoryProperties", "traits": { - "smithy.api#documentation": "

The rules you've defined for a category.

" + "smithy.api#documentation": "

Provides you with the rules associated with the category you specified in your\n GetCallAnalyticsCategory request.

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

Returns information about a call analytics job. To see the status of the job, check the\n CallAnalyticsJobStatus field. If the status is COMPLETED, the job\n is finished and you can find the results at the location specified in the TranscriptFileUri \n field. If you enable personally identifiable information (PII) redaction, the redacted transcript appears\n in the RedactedTranscriptFileUri field.

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

Retrieves information about a call analytics job.

\n

To view the job's status, refer to the CallAnalyticsJobStatus field. If the \n status is COMPLETED, the job is finished. You can then find your transcript at \n the URI specified in the TranscriptFileUri field. If you enabled personally \n identifiable information (PII) redaction, the redacted transcript appears in the\n RedactedTranscriptFileUri field.

", "smithy.api#http": { "method": "GET", "uri": "/callanalyticsjobs/{CallAnalyticsJobName}", @@ -1436,7 +1436,7 @@ "CallAnalyticsJobName": { "target": "com.amazonaws.transcribe#CallAnalyticsJobName", "traits": { - "smithy.api#documentation": "

The name of the analytics job you want information about. This value is case\n sensitive.

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

The name of the analytics job you want information about. This value is case\n sensitive.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1449,7 +1449,7 @@ "CallAnalyticsJob": { "target": "com.amazonaws.transcribe#CallAnalyticsJob", "traits": { - "smithy.api#documentation": "

An object that contains the results of your call analytics job.

" + "smithy.api#documentation": "

An object that contains detailed information about your call analytics job. Returned fields\n include: CallAnalyticsJobName, CallAnalyticsJobStatus,\n ChannelDefinitions, CompletionTime,\n CreationTime, DataAccessRoleArn,\n FailureReason, IdentifiedLanguageScore, \n LanguageCode, Media, MediaFormat,\n MediaSampleRateHertz, Settings, StartTime,\n and Transcript.

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

Returns information about a transcription job from Amazon Transcribe Medical. To see the status of the job, check the\n TranscriptionJobStatus field. If the status is COMPLETED, the job is finished. You \n find the results of the completed job in the TranscriptFileUri field.

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

Retrieves information about a medical transcription job.

\n

To view the job's status, refer to the TranscriptionJobStatus field. If the \n status is COMPLETED, the job is finished. You can then find your transcript at \n the URI specified in the TranscriptFileUri field.

", "smithy.api#http": { "method": "GET", "uri": "/medicaltranscriptionjobs/{MedicalTranscriptionJobName}", @@ -1491,7 +1491,7 @@ "MedicalTranscriptionJobName": { "target": "com.amazonaws.transcribe#TranscriptionJobName", "traits": { - "smithy.api#documentation": "

The name of the medical transcription job.

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

The name of the medical transcription job you want information about. This value is case\n sensitive.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1504,7 +1504,7 @@ "MedicalTranscriptionJob": { "target": "com.amazonaws.transcribe#MedicalTranscriptionJob", "traits": { - "smithy.api#documentation": "

An object that contains the results of the medical transcription job.

" + "smithy.api#documentation": "

An object that contains detailed information about your medical transcription job.\n Returned fields include: CompletionTime,\n ContentIdentificationType, CreationTime,\n FailureReason, LanguageCode, Media,\n MediaFormat, MediaSampleRateHertz, \n MedicalTranscriptionJobName, Settings,\n Specialty, StartTime, Tags,\n Transcript, TranscriptionJobStatus, and\n Type.

" } } } @@ -1546,7 +1546,7 @@ "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

The name of the vocabulary that you want information about. The value is case sensitive.

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

The name of the medical vocabulary you want information about. This value is case \n sensitive.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1583,13 +1583,13 @@ "FailureReason": { "target": "com.amazonaws.transcribe#FailureReason", "traits": { - "smithy.api#documentation": "

If the VocabularyState is FAILED, this field contains information about why\n the job failed.

" + "smithy.api#documentation": "

If your request returns a VocabularyState that is FAILED,\n the FailureReason field contains information about why the request \n failed.

\n

For more information, refer to the Common Errors\n section.

" } }, "DownloadUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The location in Amazon S3 where the vocabulary is stored. Use this URI to get the contents of the vocabulary. You \n can download your vocabulary from the URI for a limited time.

" + "smithy.api#documentation": "

The S3 location where the vocabulary is stored; use this URI to view or download the\n vocabulary.

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

Returns information about a transcription job. To see the status of the job, check the \n TranscriptionJobStatus field. If the status is COMPLETED, the job is finished and\n you can find the results at the location specified in the TranscriptFileUri field. If you enable content \n redaction, the redacted transcript appears in RedactedTranscriptFileUri.

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

Returns information about a transcription job. To see the status of the job, check the \n TranscriptionJobStatus field. If the status is COMPLETED, \n the job is finished and you can find the results at the location specified in the\n TranscriptFileUri field. If you enable content redaction, the redacted\n transcript appears in RedactedTranscriptFileUri.

", "smithy.api#http": { "method": "GET", "uri": "/transcriptionjobs/{TranscriptionJobName}", @@ -2187,7 +2187,7 @@ "UpgradeAvailability": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

Whether the base model used for the custom language model is up to date. If this field \n is true then you are running the most up-to-date version of the base model \n in your custom language model.

" + "smithy.api#documentation": "

Whether the base model used for the custom language model is up to date. If this field \n is false then you are running the most up-to-date version of the base model \n in your custom language model.

" } }, "FailureReason": { @@ -2600,14 +2600,14 @@ "NextToken": { "target": "com.amazonaws.transcribe#NextToken", "traits": { - "smithy.api#documentation": "

If the result of your previous request to ListMedicalVocabularies was\n truncated, include the NextToken to fetch the next set of vocabularies.

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

If the result of your previous request to ListMedicalVocabularies was\n truncated, include the NextToken to fetch the next set of\n vocabularies.

", "smithy.api#httpQuery": "NextToken" } }, "MaxResults": { "target": "com.amazonaws.transcribe#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of vocabularies to return in each page of results. If there are fewer \n results than the value you specify, only the actual results are returned. If you do not specify \n a value, the default of 5 is used.

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

The maximum number of vocabularies to return in each page of results. If there are\n fewer results than the value you specify, only the actual results are returned. If you do not\n specify a value, the default of 5 is used.

", "smithy.api#httpQuery": "MaxResults" } }, @@ -2639,7 +2639,7 @@ "NextToken": { "target": "com.amazonaws.transcribe#NextToken", "traits": { - "smithy.api#documentation": "

The ListMedicalVocabularies operation returns a page of vocabularies at a\n time. You set the maximum number of vocabularies to return on a page with the\n MaxResults parameter. If there are more jobs in the list will fit on a page, \n Amazon Transcribe Medical returns the NextPage token. To return the next page of vocabularies, \n include the token in the next request to the ListMedicalVocabularies \n operation .

" + "smithy.api#documentation": "

The ListMedicalVocabularies operation returns a page of vocabularies at \n a time. You set the maximum number of vocabularies to return on a page with the\n MaxResults parameter. If there are more jobs in the list will fit on a page, \n Amazon Transcribe Medical returns the NextPage token. To return the next page of vocabularies,\n include the token in the next request to the ListMedicalVocabularies \n operation.

" } }, "Vocabularies": { @@ -3001,7 +3001,7 @@ "MediaFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The S3 object location of the input media file. The URI must be in the same region as \n the API endpoint that you are calling. The general form is:

\n

\n s3:////\n

\n

For example:

\n

\n s3://AWSDOC-EXAMPLE-BUCKET/example.mp4\n

\n

\n s3://AWSDOC-EXAMPLE-BUCKET/mediadocs/example.mp4\n

\n

For more information about S3 object names, see Object Keys in the\n Amazon S3 Developer Guide.

" + "smithy.api#documentation": "

The S3 object location of the input media file. The URI must be in the same region as \n the API endpoint that you are calling. The general form is:

\n

\n s3://DOC-EXAMPLE-BUCKET/keyprefix/objectkey\n

\n

For example:

\n

\n s3://DOC-EXAMPLE-BUCKET/example.flac\n

\n

\n s3://DOC-EXAMPLE-BUCKET/mediafiles/example.flac\n

\n

For more information about S3 object names, see Object Keys in the\n Amazon S3 Developer Guide.

" } }, "RedactedMediaFileUri": { @@ -3071,6 +3071,16 @@ ] } }, + "com.amazonaws.transcribe#MedicalMediaSampleRateHertz": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 16000, + "max": 48000 + } + } + }, "com.amazonaws.transcribe#MedicalTranscript": { "type": "structure", "members": { @@ -3107,7 +3117,7 @@ } }, "MediaSampleRateHertz": { - "target": "com.amazonaws.transcribe#MediaSampleRateHertz", + "target": "com.amazonaws.transcribe#MedicalMediaSampleRateHertz", "traits": { "smithy.api#documentation": "

The sample rate, in Hertz, of the source audio containing medical information.

\n

If you don't specify the sample rate, Amazon Transcribe Medical determines it for you. If you choose to \n specify the sample rate, it must match the rate detected by Amazon Transcribe Medical.

" } @@ -3951,7 +3961,7 @@ } }, "MediaSampleRateHertz": { - "target": "com.amazonaws.transcribe#MediaSampleRateHertz", + "target": "com.amazonaws.transcribe#MedicalMediaSampleRateHertz", "traits": { "smithy.api#documentation": "

The sample rate, in Hertz, of the audio track in the input media file.

\n

If you do not specify the media sample rate, Amazon Transcribe Medical determines the sample rate. If you \n specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you\n should leave the MediaSampleRateHertz field blank and let Amazon Transcribe Medical determine\n the sample rate.

" } @@ -4022,7 +4032,7 @@ "Tags": { "target": "com.amazonaws.transcribe#TagList", "traits": { - "smithy.api#documentation": "

Add tags to an Amazon Transcribe medical transcription job.

" + "smithy.api#documentation": "

Add tags to an Amazon Transcribe Medical transcription job.

" } } } @@ -4263,12 +4273,12 @@ "SubtitleFileUris": { "target": "com.amazonaws.transcribe#SubtitleFileUris", "traits": { - "smithy.api#documentation": "

Choose the output location for your subtitle file. This location must be an S3 \n bucket.

" + "smithy.api#documentation": "

Contains the output location for your subtitle file. This location must be an S3 \n bucket.

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

Specify the output format for your subtitle file.

" + "smithy.api#documentation": "

Choose the output format for your subtitle file and the S3 location where you want\n your file saved.

" } }, "com.amazonaws.transcribe#Tag": { @@ -5071,7 +5081,7 @@ "VocabularyFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The location in Amazon S3 of the text file that contains your custom vocabulary. The URI must\n be in the same Amazon Web Services Region as the resource that you are calling. The following\n is the format for a URI:

\n

\n https://s3..amazonaws.com/// \n

\n

For example:

\n

\n https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt\n

\n

For more information about Amazon S3 object names, see Object Keys in the\n Amazon S3 Developer Guide.

\n

For more information about custom vocabularies in Amazon Transcribe Medical, see Medical Custom\n Vocabularies.

" + "smithy.api#documentation": "

The location in Amazon S3 of the text file that contains your custom vocabulary. The URI must\n be in the same Amazon Web Services Region as the resource that you are calling. The following\n is the format for a URI:

\n

\n https://s3.aws-region.amazonaws.com/bucket-name/keyprefix/objectkey\n

\n

For example:

\n

\n https://s3.us-east-1.amazonaws.com/DOC-EXAMPLE-BUCKET/vocab.txt\n

\n

For more information about Amazon S3 object names, see Object Keys in the\n Amazon S3 Developer Guide.

\n

For more information about custom vocabularies in Amazon Transcribe Medical, see Medical Custom\n Vocabularies.

" } } } @@ -5245,7 +5255,7 @@ "VocabularyFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The S3 location of the text file that contains the definition of the custom vocabulary. \n The URI must be in the same region as the API endpoint that you are calling. The general form\n is:

\n

\n https://s3..amazonaws.com///\n

\n

For example:

\n

\n https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt\n

\n

For more information about S3 object names, see Object Keys in the\n Amazon S3 Developer Guide.

\n

For more information about custom vocabularies, see Custom \n Vocabularies.

" + "smithy.api#documentation": "

The S3 location of the text file that contains the definition of the custom vocabulary. \n The URI must be in the same region as the API endpoint that you are calling. The general form\n is:

\n

\n https://s3.aws-region.amazonaws.com/bucket-name/keyprefix/objectkey\n

\n

For example:

\n

\n https://s3.us-east-1.amazonaws.com/DOC-EXAMPLE-BUCKET/vocab.txt\n

\n

For more information about S3 object names, see Object Keys in the\n Amazon S3 Developer Guide.

\n

For more information about custom vocabularies, see Custom \n Vocabularies.

" } } } diff --git a/aws/sdk/aws-models/transfer.json b/aws/sdk/aws-models/transfer.json index 39b524615a..74694b8144 100644 --- a/aws/sdk/aws-models/transfer.json +++ b/aws/sdk/aws-models/transfer.json @@ -320,10 +320,16 @@ } }, "PostAuthenticationLoginBanner": { - "target": "com.amazonaws.transfer#PostAuthenticationLoginBanner" + "target": "com.amazonaws.transfer#PostAuthenticationLoginBanner", + "traits": { + "smithy.api#documentation": "

Specify a string to display when users connect to a server. This string is displayed after the user authenticates.

\n \n

The SFTP protocol does not support post-authentication display banners.

\n " + } }, "PreAuthenticationLoginBanner": { - "target": "com.amazonaws.transfer#PreAuthenticationLoginBanner" + "target": "com.amazonaws.transfer#PreAuthenticationLoginBanner", + "traits": { + "smithy.api#documentation": "

Specify a string to display when users connect to a server. This string is displayed before the user authenticates.\n For example, the following banner displays details about using the system.

\n

\n This system is for the use of authorized users only. Individuals using this computer system without authority,\n or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by\n system personnel.\n

" + } }, "Protocols": { "target": "com.amazonaws.transfer#Protocols", @@ -1062,7 +1068,59 @@ } ], "traits": { - "smithy.api#documentation": "

Describes a file transfer protocol-enabled server that you specify by passing the\n ServerId parameter.

\n\n

The response contains a description of a server's properties. When you set\n EndpointType to VPC, the response will contain the\n EndpointDetails.

" + "smithy.api#documentation": "

Describes a file transfer protocol-enabled server that you specify by passing the\n ServerId parameter.

\n\n

The response contains a description of a server's properties. When you set\n EndpointType to VPC, the response will contain the\n EndpointDetails.

", + "smithy.waiters#waitable": { + "ServerOffline": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "Server.State", + "expected": "OFFLINE", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Server.State", + "expected": "STOP_FAILED", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 30 + }, + "ServerOnline": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "Server.State", + "expected": "ONLINE", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Server.State", + "expected": "START_FAILED", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 30 + } + } } }, "com.amazonaws.transfer#DescribeServerRequest": { @@ -1413,10 +1471,16 @@ } }, "PostAuthenticationLoginBanner": { - "target": "com.amazonaws.transfer#PostAuthenticationLoginBanner" + "target": "com.amazonaws.transfer#PostAuthenticationLoginBanner", + "traits": { + "smithy.api#documentation": "

Specify a string to display when users connect to a server. This string is displayed after the user authenticates.

\n \n

The SFTP protocol does not support post-authentication display banners.

\n " + } }, "PreAuthenticationLoginBanner": { - "target": "com.amazonaws.transfer#PreAuthenticationLoginBanner" + "target": "com.amazonaws.transfer#PreAuthenticationLoginBanner", + "traits": { + "smithy.api#documentation": "

Specify a string to display when users connect to a server. This string is displayed before the user authenticates.\n For example, the following banner displays details about using the system.

\n

\n This system is for the use of authorized users only. Individuals using this computer system without authority,\n or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by\n system personnel.\n

" + } }, "Protocols": { "target": "com.amazonaws.transfer#Protocols", @@ -1707,7 +1771,7 @@ "Type": { "target": "com.amazonaws.transfer#ExecutionErrorType", "traits": { - "smithy.api#documentation": "

Specifies the error type: currently, the only valid value is PERMISSION_DENIED, which occurs\n if your policy does not contain the correct permissions to complete one or more of the steps in the workflow.

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

Specifies the error type.

\n
    \n
  • \n

    \n ALREADY_EXISTS: occurs for a copy step, if the overwrite option is not selected and a file with the same name already exists in the target location.

    \n
    • \n
  • \n

    \n BAD_REQUEST: a general bad request: for example, a step that attempts to\n tag an EFS file returns BAD_REQUEST, as only S3 files can be tagged.

    \n
    • \n
  • \n

    \n CUSTOM_STEP_FAILED: occurs when the custom step provided a callback that indicates failure.

    \n
    • \n
  • \n

    \n INTERNAL_SERVER_ERROR: a catch-all error that can occur for a variety of\n reasons.

    \n
    • \n
  • \n

    \n NOT_FOUND: occurs when a requested entity, for example a source file for\n a copy step, does not exist.

    \n
    • \n
  • \n

    \n PERMISSION_DENIED: occurs if your policy does not contain the correct\n permissions to complete one or more of the steps in the workflow.

    \n
    • \n
  • \n

    \n TIMEOUT: occurs when the execution times out.

    \n \n

    You can set the TimeoutSeconds for a custom step, anywhere from 1 second to 1800 seconds (30 minutes).

    \n     \n
    • \n
  • \n

    \n THROTTLED: occurs if you exceed the new execution refill rate of one\n workflow per second.

    \n
    • \n
", "smithy.api#required": {} } }, @@ -1733,6 +1797,34 @@ { "value": "PERMISSION_DENIED", "name": "PERMISSION_DENIED" + }, + { + "value": "CUSTOM_STEP_FAILED", + "name": "CUSTOM_STEP_FAILED" + }, + { + "value": "THROTTLED", + "name": "THROTTLED" + }, + { + "value": "ALREADY_EXISTS", + "name": "ALREADY_EXISTS" + }, + { + "value": "NOT_FOUND", + "name": "NOT_FOUND" + }, + { + "value": "BAD_REQUEST", + "name": "BAD_REQUEST" + }, + { + "value": "TIMEOUT", + "name": "TIMEOUT" + }, + { + "value": "INTERNAL_SERVER_ERROR", + "name": "INTERNAL_SERVER_ERROR" } ] } @@ -2187,6 +2279,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Accesses", "pageSize": "MaxResults" } } @@ -2270,6 +2363,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Executions", "pageSize": "MaxResults" } } @@ -2350,6 +2444,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "SecurityPolicyNames", "pageSize": "MaxResults" } } @@ -2416,6 +2511,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Servers", "pageSize": "MaxResults" } } @@ -2482,6 +2578,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Tags", "pageSize": "MaxResults" } } @@ -2563,6 +2660,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Users", "pageSize": "MaxResults" } } @@ -2643,6 +2741,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Workflows", "pageSize": "MaxResults" } } @@ -4367,10 +4466,16 @@ } }, "PostAuthenticationLoginBanner": { - "target": "com.amazonaws.transfer#PostAuthenticationLoginBanner" + "target": "com.amazonaws.transfer#PostAuthenticationLoginBanner", + "traits": { + "smithy.api#documentation": "

Specify a string to display when users connect to a server. This string is displayed after the user authenticates.

\n \n

The SFTP protocol does not support post-authentication display banners.

\n " + } }, "PreAuthenticationLoginBanner": { - "target": "com.amazonaws.transfer#PreAuthenticationLoginBanner" + "target": "com.amazonaws.transfer#PreAuthenticationLoginBanner", + "traits": { + "smithy.api#documentation": "

Specify a string to display when users connect to a server. This string is displayed before the user authenticates.\n For example, the following banner displays details about using the system.

\n

\n This system is for the use of authorized users only. Individuals using this computer system without authority,\n or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by\n system personnel.\n

" + } }, "Protocols": { "target": "com.amazonaws.transfer#Protocols", diff --git a/gradle.properties b/gradle.properties index d2e604e86b..db1af7b44f 100644 --- a/gradle.properties +++ b/gradle.properties @@ -8,10 +8,10 @@ rust.msrv=1.56.1 # Version number to use for the generated SDK # Note: these must always be full 3-segment semver versions -aws.sdk.version=0.8.0 +aws.sdk.version=0.9.0 # Version number to use for the generated runtime crates -smithy.rs.runtime.crate.version=0.38.0 +smithy.rs.runtime.crate.version=0.39.0 kotlin.code.style=official